This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
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
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

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 toggle 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 toggle 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 toggle 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 time in seconds during which the text is displayed on the screen.
  • Command.   Sets 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 the current 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.
  • 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 - Background update is disabled. (by default)
1 - Background update is enabled (rendering is performed when the window is out of focus, but stops if the window is minimized).
2 - Background update is always enabled (rendering is performed always, regardless of the window state).
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
1 - enabled (by default)
shaders_preloadConfig file: *.boot
Description:
  • Variable.   Prints the current value indicating if preloading of shaders is enabled 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).
  • Command.   Sets the value indicating if preloading of shaders is enabled 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.
1 - Only shaders that are available in the shader cache are loaded. (by default)
2 - All shaders are loaded, any shaders unavailable in cache are compiled.
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_async_load_node_references
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.  
    • Enables asynchronous loading of Node References at loading the world.
Arguments:
0 - disabled (by default)
1 - enabled

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).
render_materials_quality
Description:
  • Variable.   Prints the current quality level of the rendered materials. Depending on the specified level, a certain set of features inside graph-based materials connected to the corresponding input of a Material Quality Switch node will be applied.
  • Command.   Sets the quality level of the rendered materials. Depending on the specified level, a certain set of features inside graph-based materials connected to the corresponding input of a Material Quality Switch node will be applied.
Arguments:
0 - Low
1 - Medium
2 - High (by default)
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 and so on are displayed.
  • Command. Displays node handlers for lights, particle systems, 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
render_show_field_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 field mask.
Arguments:
0 - disabled (by default)
1 - enabled
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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.
Notice
Please note that the argument is an integer value, so the bit mask has to be represented accordingly.
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 the current Switches the mode of displaying collision shapes for physical bodies.
  • Command.   Sets the Switches the mode of displaying collision shapes for physical bodies.
Arguments:
0 - collision shapes are not shown (by default)
1 - collision shapes are rendered in wireframe mode
2 - collision shapes are rendered in solid mode

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
render_show_texture_resolution_streaming_accounting_mode
Description:
  • Variable.   Prints the current streaming accounting mode. The following modes are available:
    • Actual Resolution renders texel density based on the actual streaming result.
    • Requested Texture Resolution renders texel density for the current surface only, based on the surface texture resolution requested by the streaming system.
    • Source Texture Resolution renders texel density relative to the 0 mip level of the texture as if mipmap loading is disabled in the streaming system. This mode helps determine if the source texture resolution should be reduced.
  • Command.   Sets the streaming accounting mode. The following modes are available:
    • Actual Resolution renders texel density based on the actual streaming result.
    • Requested Texture Resolution renders texel density for the current surface only, based on the surface texture resolution requested by the streaming system.
    • Source Texture Resolution renders texel density relative to the 0 mip level of the texture as if mipmap loading is disabled in the streaming system. This mode helps determine if the source texture resolution should be reduced.
Arguments:
0 - Actual Resolution (by default)
1 - Requested Texture Resolution
2 - Source Texture Resolution

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 a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the Performance profiler.
Arguments:
0 - disabled
1 - enabled (by default)
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)
show_profiler_tableConfig 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 table.
Arguments:
0 - disabled
1 - enabled (by default)
show_profiler_genericConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the generic performance profiler.
Arguments:
0 - disabled (by default)
1 - enabled
show_profiler_memoryConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the memory performance profiler.
Arguments:
0 - disabled (by default)
1 - enabled
show_profiler_physicsConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the physics performance profiler.
Arguments:
0 - disabled (by default)
1 - enabled
show_profiler_renderConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the rendering performance profiler.
Arguments:
0 - disabled
1 - enabled (by default)
show_profiler_threadConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the thread performance profiler.
Arguments:
0 - disabled (by default)
1 - enabled
show_profiler_worldConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the world management performance profiler.
Arguments:
0 - disabled (by default)
1 - enabled

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_debug_modeConfig file: *.boot
Description:
  • Variable.   Prints the current debug mode for VR API.
  • Command.   Sets the debug mode for VR API.
    Notice
    When the debug mode is enabled, a severe slowdown may occur.
Arguments:
0 - release VR context (no debug) (by default)
1 - debug VR context
2 - debug VR context with break on error (only on debug binaries)
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.
vr_mixed_reality_camera_vst_reprojection_mode
Description:
  • Variable.   Prints the current reprojection mode of VST.
  • Command.   Sets the reprojection mode of VST.
Arguments:
0 - reprojection of VST is disabled (default). (by default)
1 - automatic reprojection mode of VST (the Depth buffer is used for reprojection)
2 - manual reprojections mode of VST
vr_mixed_reality_camera_vst_reprojection_distance
Description:
  • Variable.   Prints the current static distance in meters used to shift the whole image. Is configured only if the VST reprojection mode is set to Manual.
  • Command.   Sets the static distance in meters used to shift the whole image. Is configured only if the VST reprojection mode is set to Manual.
Arguments:
[0.0f; 1000.0f] - available range
0.0f - by default

VR Hand Tracking Settings#

vr_hand_tracking_show_basisConfig 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 visualizer for the basis of each hand bone is enabled. This option requires the hand visualizer to be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
vr_hand_tracking_show_bone_sizesConfig 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 visualizer for the size of each hand bone is enabled. This option requires the hand visualizer to be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
vr_hand_tracking_show_velocityConfig 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 visualizer for the velocity vectors of each hand bone is enabled. This option requires the hand visualizer to be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
vr_hand_tracking_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 if the visualizer for hands is enabled. This option requires the visualizer mode to be enabled.
Arguments:
0 - disabled (by default)
1 - enabled

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 status of debug shaders for the application regardless of its binary type (debug or release).
  • Command.   Sets the status of 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.

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_animations_life_time
Description:
  • Variable.   Prints the current lifetime of GPU cache used for animations rendering.
  • Command.   Sets the lifetime of GPU cache used for animations rendering.
Arguments:
[-1; INT_MAX] - 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_free_space_ram
Description:
  • Variable.   Prints the current size of additionally reserved RAM for allocations per frame, in bytes.
  • Command.   Sets the size of additionally reserved RAM for allocations per frame, in bytes.
Arguments:
[0; INT_MAX] - available range
1024 - by default
render_streaming_free_space_vram
Description:
  • Variable.   Prints the current size of additionally reserved VRAM for allocations per frame, in bytes.
  • Command.   Sets the size of additionally reserved VRAM for allocations per frame, in bytes.
Arguments:
[0; INT_MAX] - available range
512 - by default
render_streaming_usage_limit_ram
Description:
  • Variable.   Prints the current percentage of the committed memory available for streaming.
  • Command.   Sets the percentage of the committed memory available for streaming. If the streaming exceeds the RAM usage limit, the application will crash.
Arguments:
[10; 100] - available range
80 - by default
render_streaming_usage_limit_vram
Description:
  • Variable.   Prints the current percentage of the committed video memory available for streaming.
  • Command.   Sets the percentage of the committed video memory available for streaming. If the streaming exceeds the VRAM usage limit, it will start using RAM for loading graphic resources.
Arguments:
[10; 100] - available range
80 - 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.
Arguments:
0 - asynchronous streaming (by default)
1 - force-loading of resources
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.
Arguments:
0 - asynchronous streaming (by default)
1 - force-loading of resources
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_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 2 modes of loading such meshes to RAM:
    • Disable - loading is disabled.
    • Radius - meshes within the prefetch radius are loaded.
    This method should be used when the Async streaming mode for meshes is set.
Arguments:
0 - disable (by default)
1 - radius
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 2 modes of loading such meshes to RAM:
    • Disable - loading is disabled.
    • Radius - all meshes within the prefetch radius are loaded.
    This method should be used when the Async streaming mode for meshes is set.
Arguments:
0 - disable (by default)
1 - radius
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_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_mipmaps
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether texture mipmap loading is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_streaming_textures_mipmaps_density
Description:
  • Variable.   Prints the current density of mipmaps relative to the screen resolution.
  • Command.   Sets the density of mipmaps relative to the screen resolution. This value helps to define which mipmap should be loaded at the current moment. You can specify different values for different quality presets.
Arguments:
[0.0f; 1000000.0f] - available range
2.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 render manager's textures.
render_streaming_vram_budget
Description:
  • Variable.   Prints the current mode for determining the amount of available VRAM.
  • Command.   Sets the mode for determining the amount of available VRAM. The following modes are available:
    • System - the available VRAM size is obtained from the operating system.
    • Driver - the VRAM available for the application is determined by the video driver.
    • Full GPU Memory - all VRAM is available for the application.
Arguments:
0 - System
1 - Driver (by default)
2 - Full GPU Memory
render_streaming_vram_overcommit
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether VRAM limits (both the usage limit and free space) are applied.
Arguments:
0 - disabled (by default)
1 - enabled

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_ssrtgi_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_ssrtgi_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_ssrtgi_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_color_clamping_blur_resolution
Description:
  • Variable.   Prints the current resolution of the Color Clamping Blur buffer. This buffer allows for reducing ghosting artifacts and information lost areas. The Full resolution is the slowest one, so we don't recommend using it.
  • Command.   Sets the resolution of the Color Clamping Blur buffer. This buffer allows for reducing ghosting artifacts and information lost areas. The Full resolution is the slowest one, so we don't recommend using it.
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (2)
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_wrong_velocity_fix_by_depth_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether correction of a wrong velocity during the denoise process is enabled. It helps reduce ghosting artifacts around moving objects.
Arguments:
0 - disabled
1 - enabled
render_denoise_wrong_velocity_fix_by_depth_threshold
Description:
  • Variable.   Prints the current threshold value of the difference between the depth in the current pixel and the pixel read using reprojection based on velocity. This threshold defines when to applying correction of incorrect velocity during the denoise process.
  • Command.   Sets the threshold value of the difference between the depth in the current pixel and the pixel read using reprojection based on velocity. This threshold defines when to applying correction of incorrect velocity during the denoise process.
Arguments:
[0.0f; inf] - available range
0.03f - 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 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 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_exposure_min_luminance
Description:
  • Variable.   Prints the current minimum luminance offset relative to the default luminance of the scene used for rendering of adaptive exposure effect: the higher the value, the darker the adapted image will be. The parameter can take on negative values.
    Notice
    If the specified value is greater than the current maximum luminance, the maximum luminance value will be changed to the specified minimum luminance so that they are equal.
  • Command.   Sets the minimum luminance offset relative to the default luminance of the scene used for rendering of adaptive exposure effect: the higher the value, the darker the adapted image will be. The parameter can take on negative values.
    Notice
    If the specified value is greater than the current maximum luminance, the maximum luminance value will be changed to the specified minimum luminance so that they are equal.
Arguments:
[-10.0f; 10.0f] - available range
-5.0f - by default
render_exposure_max_luminance
Description:
  • Variable.   Prints the current maximum luminance offset relative to the default luminance of the scene used for rendering of adaptive exposure effect: the lower the value, the brighter the adapted image will be. The parameter can take on negative values.
    Notice
    If the specified value is less than the current minimum luminance, the minimum luminance value will be changed to the specified maximum luminance so that they are equal.
  • Command.   Sets the maximum luminance offset relative to the default luminance of the scene used for rendering of adaptive exposure effect: the lower the value, the brighter the adapted image will be. The parameter can take on negative values.
    Notice
    If the specified value is less than the current minimum luminance, the minimum luminance value will be changed to the specified maximum luminance so that they are equal.
Arguments:
[-10.0f; 10.0f] - available range
10.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 effect of auto exposure and white balance correction on 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_ssrtgi_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_ssrtgi_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
render_ssgi_information_lost_fix
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the information lost fix option is enabled for the ray-traced SSGI (Screen Space Global Illumination). This option removes artifacts in the information lost areas around 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_ssrtgi_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_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_ssrtgi_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_catmull_resampling_sharpness
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_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
0.7f - 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_taa_information_lost_frame_count
Description:
  • Variable.   Prints the current number of TAA accumulation frames in the information lost areas. "Information lost" refers to rendering of the surfaces that weren't rendered in the prevoius frame.
  • Command.   Sets the number of TAA accumulation frames in the information lost areas. "Information lost" refers to rendering of the surfaces that weren't rendered in the prevoius frame.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_taa_information_lost_depth_threshold
Description:
  • Variable.   Prints the current threshold value for the depth difference used to calculate information lost areas. "Information lost" refers to rendering of the surfaces that weren't rendered in the prevoius frame.
  • Command.   Sets the threshold value for the depth difference used to calculate information lost areas. "Information lost" refers to rendering of the surfaces that weren't rendered in the prevoius frame.
Arguments:
[0.0f; inf] - available range
0.1f - 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. The FoV value in any selected mode is 110.
  • Command.   Sets the value indicating the current VR emulation mode. The FoV value in any selected mode is 110.
Arguments:
0 - Disabled (by default)
1 - HTC Vive (1512x1680)
2 - HTC Vive Pro (2016x2240)
3 - Oculus Rift (1332x1586)
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
render_ssr_information_lost_fix
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the information lost fix option is enabled for the SSR (Screen Space Reflections). This option removes artifacts in the information lost areas around 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_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
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 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_ssrtgi_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_ssrtgi_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 is enabled for the SSRTGI (Screen Space Ray-Traced Global Illumination). This option reduces visual artifacts by increasing accuracy of the last step. SSRTGI must be enabled (see the render_ssrtgi_preset).
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_ssrtgi_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_ssrtgi_noise_step
Description:
  • Variable.   Prints the current intensity of the step noise used for SSRTGI calculation.
  • Command.   Sets the intensity of the step noise used for SSRTGI calculation. This parameter is used to reduce the banding effect of tracing by using the noise: the higher is the value, the less pronounced is the banding effect. SSRTGI must be enabled (see the render_ssrtgi_preset).
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_ssrtgi_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_ssrtgi_num_rays
Description:
  • Variable.   Prints the current number of rays of SSRTGI per pixel that are used to calculate the final image.
  • Command.   Sets the number of rays of SSRTGI per pixel that are used to calculate the final image. Using more rays provides more precise SSRTGI calculation, however, it is more expensive. SSRTGI must be enabled (see the render_ssrtgi_preset).
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_ssrtgi_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 1024] - available range
8 - by default
render_ssrtgi_num_steps
Description:
  • Variable.   Prints the current number of steps of SSRTGI per ray that are used for trace calculation.
  • Command.   Sets the number of steps of SSRTGI per ray that are used for trace calculation. The higher the value, the more accurate obstacles between objects are accounted. However, this option significantly affects performance. SSRTGI must be enabled (see the render_ssrtgi_preset).
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_ssrtgi_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 256] - available range
8 - by default
render_ssrtgi_resolution
Description:
  • Variable.   Prints the current resolution of the SSRTGI (screen space ray-traced global illumination) effect.
  • Command.   Sets the resolution of the SSRTGI (screen space ray-traced global illumination) effect. This option significantly affects performance. At low values, edges of objects become blurred. SSRTGI must be enabled (see the render_ssrtgi_preset).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (1)
render_ssrtgi_resolution_depth
Description:
  • Variable.   Prints the current resolution of the depth buffer used for SSRTGI (screen space ray-traced global illumination) calculation.
  • Command.   Sets the resolution of the depth buffer used for SSRTGI (screen space ray-traced global illumination) calculation. This option significantly affects performance. To gain performance this option can be set to lower values while enabling the increased accuracy (see the render_ssrtgi_increased_accuracy). SSRTGI must be enabled (see the render_ssrtgi_preset).
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_ssrtgi_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_ssrtgi_step_size
Description:
  • Variable.   Prints the current size of the trace step used for SSRTGI calculation.
  • Command.   Sets the size of the trace step used for SSRTGI calculation. The higher the value, the longer the trace. However, tiny objects may be missed. The lower the value, the more detailed will be the tiny objects. The SSRTGI effect must be enabled (see the render_ssrtgi_preset).
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_ssrtgi_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_ssrtgi_upscaling
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if upscaling is enabled for the SSRTGI (screen space ray-traced global illumination). This option makes the quality of edges in half and quarter resolution look closer to full. SSRTGI must be enabled (see the render_ssrtgi_preset).
Arguments:
0 - disabled
1 - enabled (by default)
render_sssss
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSSSS (Screen-Space Subsurface Scattering) effect is enabled. This effect is used to imitate human skin, wax, etc.
Arguments:
0 - disabled (by default)
1 - enabled
render_sssss_preset
Description:
  • Variable.   Prints the current SSSSS (Screen-Space Subsurface Scattering) preset used at the moment. To customize the SSSSS effect options at run time you should activate the Custom preset:
  • Command.   Sets the SSSSS (Screen-Space Subsurface Scattering) preset used at the moment. To customize the SSSSS 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_sssss_diffuse
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSSSS (Screen-Space Subsurface Scattering) calculation for diffuse lighting (directional lights) is enabled. If this option is not required, disable it to save performance. To use this option, the SSSSS effect (see the render_sssss) 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_sssss_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_sssss_ambient
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSSSS (Screen-Space Subsurface Scattering) calculation for ambient lighting (environment) is enabled. If this option is not required, disable it to save performance. To use this option, the SSSSS effect (see the render_sssss) 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_sssss_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_sssss_radius
Description:
  • Variable.   Prints the current subsurface scattering radius — distance in the screen space, within which colors will be sampled.
  • Command.   Sets the subsurface scattering radius — distance in the screen space, within which colors will be sampled.It controls how much wrinkles, pores and cavities will be blurred and highlighted. The higher the value, the farther subsurface scattering reaches. Too high values result in the ghosting effect. By the minimum value of 0, no subsurface scattering is rendered.
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_sssss_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_sssss_color
Description:
  • Variable.   Prints the current subsurface scattering color used to simulate the subsurface component of skin lighting, i.e. the light that bounces inside of the subsurface tissue layers (epidermis and dermis) before exiting.
  • Command.   Sets the subsurface scattering color used to simulate the subsurface component of skin lighting, i.e. the light that bounces inside of the subsurface tissue layers (epidermis and dermis) before exiting.For skin, subsurface color is reddish, due to blood circulating in skin tissues. To use this option, SSSSS effect (see the render_sssss) should be enabled.
Arguments:
vec4(1.0f, 0.0f, 0.0f, 1.0f) - default value
render_sssss_max_threshold
Description:
  • Variable.   Prints the current threshold of SSSSS (Screen-Space Subsurface Scattering) for the material's Translucent parameter equal to 1 (maximum translucency).
  • Command.   Sets the threshold of SSSSS (Screen-Space Subsurface Scattering) for the material's Translucent parameter equal to 1 (maximum translucency). To use this option, the SSSSS effect (see the render_sssss) 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_sssss_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
10.0f - by default
render_sssss_min_threshold
Description:
  • Variable.   Prints the current threshold of SSSSS (Screen-Space Subsurface Scattering) for the material's Translucent parameter equal to 0 (minimum translucency).
  • Command.   Sets the threshold of SSSSS (Screen-Space Subsurface Scattering) for the material's Translucent parameter equal to 0 (minimum translucency). To use this option, the SSSSS effect (see the render_sssss) 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_sssss_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_sssss_noise_ray
Description:
  • Variable.   Prints the current intensity of the ray noise used for SSSSS (Screen-Space Subsurface Scattering) calculation to reduce banding artifacts of tracing.
  • Command.   Sets the intensity of the ray noise used for SSSSS (Screen-Space Subsurface Scattering) calculation to reduce banding artifacts of tracing. Higher values make banding less visible. To use this option, the SSSSS effect (see the render_sssss) 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_sssss_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_sssss_noise_step
Description:
  • Variable.   Prints the current intensity of the step noise used for SSSSS (Screen-Space Subsurface Scattering) calculation to reduce banding artifacts of tracing.
  • Command.   Sets the intensity of the step noise used for SSSSS (Screen-Space Subsurface Scattering) calculation to reduce banding artifacts of tracing. Higher values make banding less visible. To use this option, the SSSSS effect (see the render_sssss) 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_sssss_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_sssss_interleaved
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the interleaved rendering mode for SSSSS (Screen-Space Subsurface Scattering) is enabled. This option enables rendering of the effect in only half or quarter of all pixels with subsequent reconstruction of neighboring pixels using the data from previous frames, significantly improving performance.

    The effect is cumulative and works best with Temporal Filter, which reduces ghosting and noise artifacts.

Arguments:
0 - disabled (by default)
1 - enabled
render_sssss_interleaved_color_clamping
Description:
  • Variable.   Prints the current color clamping mode used to reduce ghosting effect.
  • Command.   Sets the color clamping mode used to reduce ghosting effect. Higher values increase clamping intensity, but may cause flickering (to reduce flickering you can choose High + Velocity). When disabled, translucency has a lag as it is several frames behind.
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_sssss_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - Disabled
1 - Low (by default)
2 - Medium
3 - High
4 - High + Velocity
render_sssss_interleaved_samples
Description:
  • Variable.   Prints the current number of pixels to be skipped when rendering the SSSSS (Screen-Space Subsurface Scattering) effect with subsequent reconstruction of neighboring pixels using the data from previous frames.
  • Command.   Sets the number of pixels to be skipped when rendering the SSSSS (Screen-Space Subsurface Scattering) effect with subsequent reconstruction of neighboring pixels using the data from previous frames. The following options are available:
    • 1 x 2 (1.0 * width x 0.5 * height) — a half of all pixels is rendered, skipping each second line
    • 2 x 2 (0.5 * width x 0.5 * height) — a quarter of all pixels is rendered, skipping each second line and row
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_sssss_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - 1 x 2 (by default)
1 - 2 x 2
render_sssss_resolution
Description:
  • Variable.   Prints the current resolution of the SSSSS (Screen-Space Subsurface Scattering) effect.
  • Command.   Sets the resolution of the SSSSS (Screen-Space Subsurface Scattering) 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_sssss_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_sssss_quality
Description:
  • Variable.   Prints the current quality of the SSSSS (Screen-Space Subsurface Scattering) effect.
  • Command.   Sets the quality of the SSSSS (Screen-Space Subsurface Scattering) 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_sssss_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_sssss_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) for Screen-Space Subsurface Scattering is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_sssss_taa_fix_flicker
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Fix Flicker (see the render_taa_fix_flicker).
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_sssss_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_sssss_taa_antialiasing_in_motion
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_sssss_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_sssss_taa_frames_by_color
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Frames By Color (see the render_taa_frames_by_color).
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_sssss_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_sssss_taa_frames_by_velocity
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Frames By Velocity (see the render_taa_frames_by_velocity).
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_sssss_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_sssss_taa_preserve_details
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_sssss_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_sssss_taa_frame_count
Description:
Arguments:
[0.0f; inf] - available range
30.0f - by default
render_sssss_taa_frames_velocity_threshold
Description:
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_sssss_taa_max_frames_by_velocity
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_sssss_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_sssss_taa_min_frames_by_velocity
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_sssss_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_sssss_taa_pixel_offset
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_sssss_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_sssss_taa_catmull_resampling
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Catmull Resampling (see the render_taa_catmull_resampling).
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_sssss_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_sssss_taa_samples
Description:
  • Variable.   Prints the current value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Samples (see the render_taa_samples).
  • Command.   Sets the value of TAA parameter for Screen-Space Subsurface Scattering that is similar to TAA Samples (see the render_taa_samples).
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_sssss_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_translucent_color
Description:
  • Variable.   Prints the current color used for translucent objects globally.
  • Command.   Sets the color used for translucent objects globally. When light shines on one side of the object, the other side is partially illuminated with this color.
Arguments:
vec4(1.0f, 1.0f, 1.0f, 1.0f) - default value (white)
render_ssbevel
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the Screen-Space Bevels (SSBevel effect) are enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssbevel_vertex_normal
Description:
  • Variable.   Prints the current rendering mode of the screen-space bevels.
  • Command.   Sets the rendering mode of the screen-space bevels. The following modes are available:
    • Better Edges smoothes vertex and surface normals of the object. In this mode, the relief created by using Normal Mapping will be smoothed along with the mesh edges.
    • Better Normals smoothes only vertex normals. In this mode, only edges of the mesh geometry will be bevelled. The mode may produce visual artifacts on the edges. However, they can be reduced by increasing quality settings of anti-aliasing.
    To use this option, rendering of SSBevel (see the render_ssbevel) should be enabled.
Arguments:
0 - Better Edges (by default)
1 - Better Normals
render_ssbevel_quality
Description:
  • Variable.   Prints the current quality mode for the screen-space bevels.
  • Command.   Sets the quality mode for the screen-space bevels.
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_ssbevel_radius
Description:
  • Variable.   Prints the current size of the Screen-Space Bevel effect.
  • Command.   Sets the size of the Screen-Space Bevel effect. To use this option, rendering of SSBevel (see the render_ssbevel) should be enabled.
Arguments:
[0.0f; inf] - available range
0.01f - by default
render_ssbevel_noise
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the noise is enabled for smoothing bevels. It is recommended to use the noise with TAA (see the render_taa) enabled to avoid visual artifacts. The bevel noise is applied at a certain distance from the camera (i.e. if the camera is too far from the object with bevels, the noise won't be applied). To use this option, rendering of SSBevel (see the render_ssbevel) should be enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_ssdirt
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the Screen-Space Dirt (SSDirt) effect is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssdirt_quality
Description:
  • Variable.   Prints the current quality for the SSDirt effect.
  • Command.   Sets the quality for the SSDirt effect. SSDirt (see the render_ssdirt) must be enabled. Quality implies the number of samples used for the Screen-Space Dirt effect:
    • Low — 4 samples
    • Medium — 8 samples
    • High — 16 samples
    • Ultra — 32 samples
    Notice
    This parameter significantly affects performance, so choose it reasonably.
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (2)
render_ssdirt_resolution
Description:
  • Variable.   Prints the current resolution of the SSDirt effect.
  • Command.   Sets the resolution of the SSDirt effect. SSDirt (see the render_ssdirt) must be enabled.
    Notice
    This parameter significantly affects performance, so choose it reasonably.
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (1)
render_ssdirt_intensity
Description:
  • Variable.   Prints the current intensity of the SSDirt effect.
  • Command.   Sets the intensity of the SSDirt effect.
    • By the minimum value of 0.0f, the effect is not visible.
    • Higher values make the effect more pronounced.
    SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_radius
Description:
  • Variable.   Prints the current size of the SSDirt effect.
  • Command.   Sets the size of the SSDirt effect. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_threshold
Description:
  • Variable.   Prints the current threshold of the SSDirt effect.
  • Command.   Sets the threshold of the SSDirt effect. It determines depth limit for the SSDirt effect in areas where information cannot be obtained. Higher values make the effect less pronounced. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssdirt_angle_bias
Description:
  • Variable.   Prints the current angle bias value to limit the SSDirt effect where information cannot be obtained.
  • Command.   Sets the angle bias value to limit the SSDirt effect where information cannot be obtained. This parameter can be used to remove visual artefacts at the edges of polygons. SSDirt (see the render_ssdirt) must be enabled.
    Notice
    This parameter affects both, concave and convex areas.
Arguments:
[0.0f; 1.0f] - available range
0.35f - by default
render_ssdirt_perspective
Description:
  • Variable.   Prints the current perspective value, that determines the degree of impact of distance from the camera on the radius of the Screen-Space Dirt effect.
  • Command.   Sets the perspective value, that determines the degree of impact of distance from the camera on the radius of the Screen-Space Dirt effect.
    • 0.0f - radius of the effect is bound to screen space (it remains constant relative to screen size, regardless of the distance to the camera).
    • 1.0f - radius of the effect is bound to world space (it remains the same relative to objects, i.e. gets smaller as the camera moves away from them).
    SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.02f - by default
render_ssdirt_increase_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 for the SSDirt effect. This option should be used to remove visual artefacts along the screen edges, in case if they appear. Otherwise, it should be disabled. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssdirt_cavity_texture_size
Description:
  • Variable.   Prints the current scaling factor for the textures used for cavities.
  • Command.   Sets the scaling factor for the textures used for cavities. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_cavity_color
Description:
  • Variable.   Prints the current color multiplier for the Albedo texture used for cavities (global dirt and dust color pattern).
  • Command.   Sets the color multiplier for the Albedo texture used for cavities (global dirt and dust color pattern). SSDirt (see the render_ssdirt) must be enabled.
Arguments:
vec4(0.26f, 0.24f, 0.21f, 1.0f) - default value
render_ssdirt_cavity_exponent
Description:
  • Variable.   Prints the current exponent value that determines the rate of gradual change of intensity along the radius for cavities.
  • Command.   Sets the exponent value that determines the rate of gradual change of intensity along the radius for cavities. Lower values make gradual change of intensity smoother. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_cavity_metalness
Description:
  • Variable.   Prints the current metalness value for cavities.
  • Command.   Sets the metalness value for cavities. When set to 0 (by default), the SSDirt effect does not modify metalness buffer in cavities. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_ssdirt_cavity_metalness_visibility
Description:
  • Variable.   Prints the current metalness visibility value for cavities.
  • Command.   Sets the metalness visibility value for cavities. A multiplier that determines the degree of impact of the effect on metalness buffer (the higher the value the more metalness buffer is affected. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_ssdirt_convexity_texture_size
Description:
  • Variable.   Prints the current scaling factor for the textures used for convexities.
  • Command.   Sets the scaling factor for the textures used for convexities. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_convexity_color
Description:
  • Variable.   Prints the current color multiplier for the Albedo texture used for convexities (global wear and scratch color pattern).
  • Command.   Sets the color multiplier for the Albedo texture used for convexities (global wear and scratch color pattern). SSDirt (see the render_ssdirt) must be enabled.
Arguments:
vec4(0.48f, 0.44f, 0.39f, 1.0f) - default value
render_ssdirt_convexity_exponent
Description:
  • Variable.   Prints the current exponent value that determines the rate of gradual change of intensity along the radius for convexities.
  • Command.   Sets the exponent value that determines the rate of gradual change of intensity along the radius for convexities. Lower values make gradual change of intensity smoother. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssdirt_convexity_metalness
Description:
  • Variable.   Prints the current metalness value for convexities.
  • Command.   Sets the metalness value for convexities. When set to 0 (by default), the SSDirt effect does not modify metalness buffer in convex areas. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_ssdirt_convexity_metalness_visibility
Description:
  • Variable.   Prints the current metalness visibility value for convexities.
  • Command.   Sets the metalness visibility value for convexities. A multiplier that determines the degree of impact of the effect on metalness buffer (the higher the value the more metalness buffer is affected. SSDirt (see the render_ssdirt) must be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_tonemapper
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if tone mapping is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_tonemapper_mode
Description:
Arguments:
0 - Filmic
1 - ACES (by default)
2 - ACES with Reinhard
3 - Reinhard
4 - Reinhard Luma-Based
render_reinhard_contribution
Description:
  • Variable.   Prints the current Reinhard tonemapping operator contribution.
  • Command.   Sets the Reinhard tonemapping operator contribution.

    The value is calculated according to the following formula: C / (1 + C) It controls the overall contribution that the Reinhard operator makes to the final color grading of the image. The higher values result in more tonemapping contribution to the final image.

Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_reinhard_luma_based_contribution
Description:
  • Variable.   Prints the current Reinhard Luma-Based tonemapping operator contribution.
  • Command.   Sets the Reinhard Luma-Based tonemapping operator contribution. Controls the overall contribution that the Reinhard operator makes to the final color grading of the image. Higher values result in more tonemapping contribution to the final image.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_aces_with_reinhard_mix
Description:
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_aces_white_clip
Description:
  • Variable.   Prints the current white clip parameter for the ACES operator. Controls the cut-off point for white.
  • Command.   Sets the white clip parameter for the ACES operator. Controls the cut-off point for white.
Arguments:
[0.0f; 10.0f] - available range
2.51f - by default
render_aces_toe
Description:
  • Variable.   Prints the current toe parameter for the ACES operator.
  • Command.   Sets the toe parameter for the ACES operator. Controls the dark color. Higher values result in darker colors.
Arguments:
[0.0f; 10.0f] - available range
0.03f - by default
render_aces_shoulder_angle
Description:
  • Variable.   Prints the current shoulder angle parameter for the ACES operator.
  • Command.   Sets the shoulder angle parameter for the ACES operator. Controls how much overshoot should be added to the curve's shoulder.
Arguments:
[0.0f; 10.0f] - available range
2.43f - by default
render_aces_shoulder_strength
Description:
  • Variable.   Prints the current shoulder strength parameter for the ACES operator.
  • Command.   Sets the shoulder strength parameter for the ACES operator. Controls the strength of the transition between the curve's midsection and the curve's shoulder.
Arguments:
[0.0f; 10.0f] - available range
0.59f - by default
render_aces_shoulder_length
Description:
  • Variable.   Prints the current shoulder length parameter for the ACES operator.
  • Command.   Sets the shoulder length parameter for the ACES operator. Controls the amount of f-stops to add to the dynamic range of the curve. Defines how much of the highlights the curve takes into account.
Arguments:
[0.0f; 1.0f] - available range
0.59f - by default
render_aces_with_reinhard_white_clip
Description:
  • Variable.   Prints the current white clip parameter for the ACES with Reinhard operator.
  • Command.   Sets the white clip parameter for the ACES with Reinhard operator. Controls the cut-off point for white.ACES with Reinhard operator's white clip.
Arguments:
[0.0f; 10.0f] - available range
2.51f - by default
render_aces_with_reinhard_toe
Description:
  • Variable.   Prints the current toe parameter for the ACES with Reinhard operator.
  • Command.   Sets the toe parameter for the ACES with Reinhard operator. Controls the dark color. Higher values result in darker colors.
Arguments:
[0.0f; 10.0f] - available range
0.03f - by default
render_aces_with_reinhard_shoulder_angle
Description:
  • Variable.   Prints the current shoulder angle parameter for the ACES with Reinhard operator.
  • Command.   Sets the shoulder angle parameter for the ACES with Reinhard operator. Controls how much overshoot should be added to the curve's shoulder.
Arguments:
[0.0f; 10.0f] - available range
2.43f - by default
render_aces_with_reinhard_shoulder_strength
Description:
  • Variable.   Prints the current shoulder strength parameter for the ACES with Reinhard operator.
  • Command.   Sets the shoulder strength parameter for the ACES with Reinhard operator. Controls the strength of the transition between the curve's midsection and the curve's shoulder.
Arguments:
[0.0f; 10.0f] - available range
0.59f - by default
render_aces_with_reinhard_shoulder_length
Description:
  • Variable.   Prints the current shoulder length parameter for the ACES with Reinhard operator.
  • Command.   Sets the shoulder length parameter for the ACES with Reinhard operator. Controls the amount of f-stops to add to the dynamic range of the curve. Defines how much of the highlights the curve takes into account.
Arguments:
[0.0f; 1.0f] - available range
0.14f - by default
render_local_tonemapper
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the local tonemapper is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_local_tonemapper_num_blur_iterations
Description:
  • Variable.   Prints the current number of blur iterations applied to the screen texture, which is used to define bright and dark portions of the screen.
  • Command.   Sets the number of blur iterations applied to the screen texture, which is used to define bright and dark portions of the screen. A higher number of iterations increases the blur radius and reduces halo artifacts around objects, but may affect performance.
Arguments:
[0; 10] - available range
5 - by default
render_local_tonemapper_depth_threshold
Description:
  • Variable.   Prints the current depth threshold value used to detect the areas affected by local tonemapping.
  • Command.   Sets the depth threshold value used to detect the areas affected by local tonemapping. A properly set value may help to reduce halo artifacts.
Arguments:
[0.0f; 1.0f] - available range
0.9f - by default
render_local_tonemapper_tonemapping_intensity
Description:
  • Variable.   Prints the current intensity of the local tonemapping effect.
  • Command.   Sets the intensity of the local tonemapping effect.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_local_tonemapper_effect_on_dark_areas
Description:
  • Variable.   Prints the current the extent of applying the local tonemapping effect on dark areas.
  • Command.   Sets the the extent of applying the local tonemapping effect on dark areas.
Arguments:
[0.0f; 1.0f] - available range
0.1f - by default
render_local_tonemapper_effect_on_dark_areas_gamma
Description:
  • Variable.   Prints the current gamma correction value for dark areas. Specifying values greater than 1 decreases the local tone mapping effect in extremely dark areas.
  • Command.   Sets the gamma correction value for dark areas. Specifying values greater than 1 decreases the local tone mapping effect in extremely dark areas.
Arguments:
[0.0f; inf] - available range
5.0f - by default
render_local_tonemapper_target_middle_gray
Description:
  • Variable.   Prints the current the target middle gray value for tonemapping.
  • Command.   Sets the the target middle gray value for tonemapping.
Arguments:
[0.0f; 1.0f] - available range
0.4f - by default
render_local_tonemapper_luma_blurred_intensity
Description:
  • Variable.   Prints the current intensity of blurring the luma values.
  • Command.   Sets the intensity of blurring the luma values. It is recommended to keep the default value for this setting. With the value set to 0, a regular screen texture is used instead of a blurred screen texture. This might be required in a rare case of reducing the halo effect and increasing the tonemapping effect for small details.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_local_tonemapper_debug
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the the value indicating whether the debug mode for the local tonemapper is enabled.
Arguments:
0 - disabled
1 - enabled
render_local_tonemapper_blur_resolution
Description:
  • Variable.   Prints the current resolution of the blur applied during the tone mapping process.
    Notice
    It is recommended to use the Half resolution in conjunction with the Blur Upscale mode enabled.
  • Command.   Sets the resolution of the blur applied during the tone mapping process.
    Notice
    It is recommended to use the Half resolution in conjunction with the Blur Upscale mode enabled.
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (2)
render_local_tonemapper_blur_upscale
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether upscaling the blurred image from the Quarter or Half resolution to the Full one is enabled.
Arguments:
0 - disabled
1 - enabled
render_local_tonemapper_blur_upscale_kernel_size
Description:
  • Variable.   Prints the current size of the kernel used for upscaling the blurred image. The higher the value the better the upscaling quality, but the lower the performance. It is recommended to set the kernel size as follows:
    • 3x3 for the Half resolution.
    • 5x5 for the Quarter resolution.
  • Command.   Sets the size of the kernel used for upscaling the blurred image. The higher the value the better the upscaling quality, but the lower the performance. It is recommended to set the kernel size as follows:
    • 3x3 for the Half resolution.
    • 5x5 for the Quarter resolution.
Arguments:
0 - 3x3 (by default)
1 - 5x5
render_local_tonemapper_depth_difference_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether considering of the depth difference between objects in the scene is enabled. Enabling this feature allows reducing halo artifacts around objects. However, we recommend using it only in exceptional cases, as it is a performance-costly operation.
Arguments:
0 - disabled
1 - enabled
render_local_tonemapper_color_difference_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether considering of the image color rendered on the screen is enabled. Enabling this feature allows reducing halo artifacts on surfaces with sharp color transitions. For example, it can significantly improve the appearance of a distinct shadow from the sun on asphalt.
Arguments:
0 - disabled
1 - enabled
render_local_tonemapper_color_difference_threshold
Description:
  • Variable.   Prints the current threshold value that determines the extent to which color differences on the screen are considered. If you set the value to 1, the result will appear as if the Color Difference feature is turned off.
  • Command.   Sets the threshold value that determines the extent to which color differences on the screen are considered. If you set the value to 1, the result will appear as if the Color Difference feature is turned off.
Arguments:
[0.0f; 1.0f] - available range
0.1f - by default

Upscalers#

render_upscale_mode
Description:
  • Variable.   Prints the current Upscaling mode. Defines a technology to be used to render high-resolution images based on the lower resolution source, which may help preserve image quality while getting more fps.
  • Command.   Sets the Upscaling mode. Defines a technology to be used to render high-resolution images based on the lower resolution source, which may help preserve image quality while getting more fps.
Arguments:
0 - Disabled for no upscaling. 1.0x per dimension, the final image has 100% rendered resolution.
1 - FSR for Fidelity FX Super Resolution by AMD.
2 - DLSS for Deep Learning Super Sampling by NVIDIA. (by default)
render_upscale_post
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if upscaling is performed after rendering all post-effects. When disabled, upscaling is performed before applying post-effects.
Arguments:
0 - disabled (by default)
1 - enabled

DLSS#

dlss_info
Description:
  • Command. Prints the information on the DLSS upscaler: versions of the Streamline SDK and NGX library.
render_upscale_dlss_mode
Description:
  • Variable.   Prints the current DLSS quality:
    • Ultra Performance provides frames per second at the cost of internal resolution and output visuals. It may result in soft, blurry graphics because of the large gap between internal render and the output resolution.
    • Max Performance (default) prioritizes frame rate over resolution. It is recommended for users with 1440p/2K monitors, providing better performance with minimal effort.
    • Balanced balances render and output resolution trying to provide the best possible frame rate or the frame rate you request in the app settings.
    • Max Quality prioritizes visual quality over frame rate. It renders the image internally at the closest resolution possible to the target resolution.
    • DLAA (Deep learning anti-aliasing) is an AI-powered tool to eliminate jagged edges in video apps, maintaining native resolutionunlike DLSS. It improves image quality with less performance cost than traditional methods.
  • Command.   Sets the DLSS quality:
    • Ultra Performance provides frames per second at the cost of internal resolution and output visuals. It may result in soft, blurry graphics because of the large gap between internal render and the output resolution.
    • Max Performance (default) prioritizes frame rate over resolution. It is recommended for users with 1440p/2K monitors, providing better performance with minimal effort.
    • Balanced balances render and output resolution trying to provide the best possible frame rate or the frame rate you request in the app settings.
    • Max Quality prioritizes visual quality over frame rate. It renders the image internally at the closest resolution possible to the target resolution.
    • DLAA (Deep learning anti-aliasing) is an AI-powered tool to eliminate jagged edges in video apps, maintaining native resolutionunlike DLSS. It improves image quality with less performance cost than traditional methods.
Arguments:
0 - Ultra Performance
1 - Max Performance (by default)
2 - Balanced
3 - Max Quality
4 - DLAA (Deep learning anti-aliasing).
render_upscale_dlss_preset
Description:
  • Variable.   Prints the current DLSS preset.
    • A should be used for the Max Performance/Balanced/Max Quality modes.
    • B should be used for the Ultra Performance mode. Similar to the preset A but for the Ultra Performance mode.
    • C (most preferred) should be used for the Max Performance/Balanced/Max Quality modes.It generally favors current frame information; well suited for fast-paced app content.
    • D (2nd preferrable) should be used by default for the Max Performance/Balanced/Max Quality modes. It generally favors image stability.
    • E is unused.
    • F should be used by default for the Ultra Performance and DLAA modes.
  • Command.   Sets the DLSS preset.
    • A should be used for the Max Performance/Balanced/Max Quality modes.
    • B should be used for the Ultra Performance mode. Similar to the preset A but for the Ultra Performance mode.
    • C (most preferred) should be used for the Max Performance/Balanced/Max Quality modes.It generally favors current frame information; well suited for fast-paced app content.
    • D (2nd preferrable) should be used by default for the Max Performance/Balanced/Max Quality modes. It generally favors image stability.
    • E is unused.
    • F should be used by default for the Ultra Performance and DLAA modes.
Arguments:
0 - Default (by default)
1 - Preset A
2 - Preset B
3 - Preset C
4 - Preset D
5 - Preset E
6 - Preset F
7 - Preset G

FSR#

fsr_info
Description:
  • Command. Prints the information on the FSR upscaler: a version, number of contexts, RAM scratch size.
fsr_debug_checking
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Sets a value indicating if debug checking is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
fsr_max_contextsConfig file: *.boot
Description:
  • Variable.   Prints the current number of the FSR contexts.
  • Command.   Sets the number of the FSR contexts.
Arguments:
[1; 1024] - available range
8 - by default
render_upscale_fsr_mode
Description:
  • Variable.   Prints the current quality mode of FSR (FidelityFX Super Resolution upsampling technique).
    • Ultra Performance that provides highest performance gain while still maintaining an image quality representative of native rendering. 3.0x per dimension.
    • Performance that provides an image quality similar to native rendering with a major performance gain. 2.0x per dimension.
    • Balanced that offers an ideal compromise between image quality and performance gains. 1.7x per dimension.
    • Quality that provides an image quality equal or superior to native rendering with a significant performance gain. 1.5x per dimension.
  • Command.   Sets the quality mode of FSR (FidelityFX Super Resolution upsampling technique).
    • Ultra Performance that provides highest performance gain while still maintaining an image quality representative of native rendering. 3.0x per dimension.
    • Performance that provides an image quality similar to native rendering with a major performance gain. 2.0x per dimension.
    • Balanced that offers an ideal compromise between image quality and performance gains. 1.7x per dimension.
    • Quality that provides an image quality equal or superior to native rendering with a significant performance gain. 1.5x per dimension.
Arguments:
0 - Ultra Performance (by default)
1 - Performance
2 - Balanced
3 - Quality
render_upscale_fsr_enable_sharpness
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if additional sharpness pass for FidelityFX Super Resolution upscaling is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_upscale_fsr_sharpness
Description:
  • Variable.   Prints the current sharpness value
  • Command.   Sets the sharpness value, where 0 is no additional sharpness and 1 is maximum additional sharpness.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_upscale_fsr_pre_exposure
Description:
  • Variable.   Prints the current pre-exposure value
  • Command.   Sets the pre-exposure value by which we divide the input signal to get back to the original signal produced by the game before any packing into lower precision render targets.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_upscale_fsr_auto_reactive_scale
Description:
  • Variable.   Prints the current scaling factor for the reactive mask.
  • Command.   Sets the scaling factor for the reactive mask. In the context of FSR, the term 'reactivity' means how much influence the samples rendered for the current frame have over the production of the final upscaled image. Typically, samples rendered for the current frame contribute a relatively modest amount to the result computed by FSR; however, there are exceptions. To produce the best results for fast moving, alpha-blended objects, FSR requires the Reproject & accumulate stage to become more reactive for such pixels. As there is no good way to determine from either color, depth or motion vectors which pixels have been rendered using alpha blending, FSR performs best when applications explicitly mark such areas.
Arguments:
[0.0f; inf] - available range
5.0f - by default
render_upscale_fsr_auto_tc_scale
Description:
  • Variable.   Prints the current scaling factor for the transparency and composition mask.
  • Command.   Sets the scaling factor for the transparency and composition mask. In addition to the Reactive mask, FSR provides for the application to denote areas of other specialist rendering which should be accounted for during the upscaling process. Examples of such special rendering include areas of raytraced reflections or animated textures. While the Reactive mask adjusts the accumulation balance, the Transparency & composition mask adjusts the pixel history protection mechanisms. The mask also removes the effect of the luminance instability factor. A pixel with a value of 0 in the Transparency & composition mask does not perform any additional modification to the lock for that pixel. Conversely, a value of 1 denotes that the lock for that pixel should be completely removed.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_upscale_fsr_auto_tc_threshold
Description:
  • Variable.   Prints the current cutoff value for the transparency and composition mask.
  • Command.   Sets the cutoff value for the transparency and composition mask.
Arguments:
[0.0f; inf] - available range
0.05f - by default
render_upscale_fsr_auto_reactive_max
Description:
  • Variable.   Prints the current value to clamp the reactive mask.
  • Command.   Sets the value to clamp the reactive mask.
Arguments:
[0.0f; inf] - available range
0.9f - by default

Lighting and Shading#

Operations on lighting and shading.

render_environment
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of environment of the scene is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_environment_cubemap_blend
Description:
  • Variable.   Prints the current blending mode for the environment cubemap.
  • Command.   Sets the blending mode for the environment cubemap.
Arguments:
0 - alpha blend (by default)
1 - additive blend
2 - multiply
3 - overlay
render_environment_ggx_mipmaps_quality
Description:
  • Variable.   Prints the current GGX Mipmap quality mode for environment reflections on rough surfaces.
  • Command.   Sets the GGX Mipmap quality mode for environment reflections on rough surfaces. Quality modes differ in the number of rays used to create a reflection on a rough surface.
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (0)
render_environment_hemisphere
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of environment only for the top (above-ground) hemisphere is enabled. The underground is rendered black. When disabled, environment for the whole sphere is rendered.
Arguments:
0 - disabled (by default)
1 - enabled
render_environment_haze
Description:
  • Variable.   Prints the current mode for the haze effect.
  • Command.   Sets the mode for the haze effect.
    • If Disabled, no haze is applied.
    • The Solid mode uses the solid color from the Color parameter.
    • The Scattering mode uses the color from the sky LUTs is blended with the Color parameter. This value is recommended for better realism: objects will smoothly fade into the distance.
Arguments:
0 - haze disabled
1 - haze colored the specific color
2 - haze colored in accordance with the sky LUT (by default)
render_environment_haze_gradient
Description:
  • Variable.   Prints the current environment haze gradient mode.
  • Command.   Sets the environment haze gradient mode. By using this option, you can make the haze look more realistic for a specific distance range.
    • Short Distance Range — better suitable for near-surface haze
    • Long Distance Range — better suitable for hazy mountains
    • Physically Based — for physically based haze simulation
Arguments:
0 - Short Distance Range (by default)
1 - Long Distance Range
2 - Physically Based
render_environment_haze_screen_space_global_illumination
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the Screen-Space Haze Global Illumination effect is enabled. SSHGI - is a screen-space effect ensuring consistency of haze color with the current color of Global Illumination.
    Notice
    Available for Physically Based haze gradient mode only.
Arguments:
0 - disabled
1 - enabled (by default)
render_environment_haze_screen_space_global_illumination_distance_min
Description:
  • Variable.   Prints the current minimum distance at which Screen Space Haze GI calculations start to take effect.
  • Command.   Sets the minimum distance at which Screen Space Haze GI calculations start to take effect.
Arguments:
[0.0f; inf] - available range
98000.0f - by default
render_environment_haze_screen_space_global_illumination_distance_max
Description:
  • Variable.   Prints the current maximum distance within which Screen Space Haze GI calculations are performed.
  • Command.   Sets the maximum distance within which Screen Space Haze GI calculations are performed.
Arguments:
[0.0f; inf] - available range
100000.0f - by default
render_environment_haze_temporal_filter
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 the Screen-Space Haze Global Illumination effect is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_environment_haze_colorization_threshold
Description:
  • Variable.   Prints the current treshold value for scene depth used when setting haze color for the SSHGI effect in "information lost" areas on the screen.
    • 0 - haze color is defined only by surfaces currently visible on the screen.
    • 1 - haze color is defined by surfaces everywhere, even in "information lost" areas.
  • Command.   Sets the treshold value for scene depth used when setting haze color for the SSHGI effect in "information lost" areas on the screen.
    • 0 - haze color is defined only by surfaces currently visible on the screen.
    • 1 - haze color is defined by surfaces everywhere, even in "information lost" areas.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_environment_haze_colorization_intensity
Description:
  • Variable.   Prints the current colorization intensity value that defines haze color in "information lost" areas on the screen.
  • Command.   Sets the colorization intensity value that defines haze color in "information lost" areas on the screen.
    • 0 - haze in "information lost" areas will have the initial color (same as it would be without SSHGI).
    • 1 - haze in "information lost" areas will have the less bright color among the two, initial color and haze color with SSHGI correction.

    This parameter is ignored when Colorization Threshold is set to 1, as there will be no "information lost" areas not covered by SSHGI.

Arguments:
[0.0f; 1.0f] - available range
0.95f - by default
render_lightmap_color
Description:
  • Variable.   Prints the current color multiplier for lightmaps.
  • Command.   Sets the color multiplier for lightmaps.
    Notice
    Some light sources may be modified after the lightmap was baked. To make lighting in the scene consistent once again without any re-baking you can simply adjust the color multiplier for lightmaps. See the How-To video tutorial for additional information.
Arguments:
vec4_one - default value (white)
render_lights_max_per_batch
Description:
  • Variable.   Prints the current maximum number of lights rendered by a tile (see the render_lights_tile_grid_size) per batch call.
  • Command.   Sets the maximum number of lights rendered by a tile (see the render_lights_tile_grid_size) per batch call.

    With lights batching optimization, omni lights divided into tiles are rendered in batches: each tile renders the specified number of lights per batch. It allows decreasing the number of DIP calls and increasing performance. The optimization works only for omni lights with point shape and without shadows.

    0 disables batching optimization.

Arguments:
[32; 1024] - available range
1024 - by default
render_lights_tile_grid_size
Description:
  • Variable.   Prints the current number of grid tiles per axis for tiled rendering optimization.
  • Command.   Sets the number of grid tiles per axis for tiled rendering optimization. During this optimization, the screen space is divided into tiles that render lights in batches (see the render_lights_max_per_batch). The optimization works only for omni lights with point shape and without shadows.
Arguments:
[1; 32] - available range
8 - by default
render_lights_forward_per_object_world
Description:
  • Variable.   Prints the current maximum number of World lights per object (available only for materials rendered in the forward rendering pass).
  • Command.   Sets the maximum number of World lights per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 World lights per object.
Arguments:
[0; 128] - available range
4 - by default
render_lights_forward_per_object_omni
Description:
  • Variable.   Prints the current maximum number of Omni lights per object (available only for materials rendered in the forward rendering pass).
  • Command.   Sets the maximum number of Omni lights per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Omni lights per object.
Arguments:
[0; 128] - available range
4 - by default
render_lights_forward_per_object_proj
Description:
  • Variable.   Prints the current maximum number of Projected lights per object (available only for materials rendered in the forward rendering pass).
  • Command.   Sets the maximum number of Projected lights per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Projected lights per object.
Arguments:
[0; 128] - available range
4 - by default
render_lights_forward_per_object_env
Description:
  • Variable.   Prints the current maximum number of Environment Probes per object (available only for materials rendered in the forward rendering pass).
  • Command.   Sets the maximum number of Environment Probes per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Voxel Probes per object.
Arguments:
[0; 128] - available range
4 - by default
render_lights_forward_per_object_planar
Description:
  • Variable.   Prints the current maximum number of Planar Reflection Probes per object (available only for materials rendered in the forward rendering pass).
  • Command.   Sets the maximum number of Planar Reflection Probes per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Planar Reflection Probes per object.
Arguments:
[0; 128] - available range
4 - by default
render_lights_forward_per_object_voxel
Description:
  • Variable.   Prints the current maximum number of Voxel Probes per object (available only for materials rendered in the forward rendering pass).
  • Command.   Sets the maximum number of Voxel Probes per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Voxel Probes per object.
Arguments:
[0; 128] - available range
4 - by default
render_lights_lens_flares
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of per-light lens flares is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_direct_lighting_interleaved
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if interleaved mode for rendering direct lighting is enabled. When enabled, lights are rendered in half resolution with subsequent reconstruction of neighboring pixels using the data from previous frames. This mode requires a high framerate (60+ FPS), otherwise anti-aliasing quality reduces and ghosting effect becomes more pronounced. Recommended for relatively static scenes which contain a lot of light sources and do not have a lot of reflective surfaces (in case of small number of light sources may reduce performance).
Arguments:
0 - disabled (by default)
1 - enabled
render_direct_lighting_interleaved_catmull_resampling
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the Catmull-Rom resampling for interleaved rendering of direct lighting is enabled. This mode allows you to reduce image blurring when the camera moves forward/backward.
Arguments:
0 - disabled (by default)
1 - enabled
render_direct_lighting_interleaved_color_clamping
Description:
  • Variable.   Prints the current color clamping mode to be used for interleaved rendering of direct lighting.
  • Command.   Sets the color clamping mode to be used for interleaved rendering of direct lighting. This mode is used to reduce ghosting effect: higher values increase clamping intensity but may cause flickering on rippled reflective surfaces (as this mode is not so good at the object's edges). When disabled, shadows and reflections have a lag as they are several frames behind.
Arguments:
0 - Disabled
1 - Low (by default)
2 - Medium
3 - High
4 - High + Velocity
render_direct_lighting_interleaved_samples
Description:
  • Variable.   Prints the current number of samples for interleaved rendering of direct lighting defining the number of pixels to be skipped during interleaved rendering of direct lighting with subsequent reconstruction of neighboring pixels using the data from previous frames (defines the size of reduced lights buffer relative to original size).
  • Command.   Sets the number of samples for interleaved rendering of direct lighting defining the number of pixels to be skipped during interleaved rendering of direct lighting with subsequent reconstruction of neighboring pixels using the data from previous frames (defines the size of reduced lights buffer relative to original size).
    • 1 x 2 — half of all pixels are rendered skipping each second line (1.0 * width x 0.5 * height)
    • 2 x 2 — quarter of all pixels are rendered skipping each second line and row (0.5 * width x 0.5 * height)
Arguments:
0 - 1 x 2 (by default)
1 - 2 x 2
render_indirect_lighting_interleaved
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if interleaved mode for rendering indirect lighting is enabled. When enabled, lights are rendered in half resolution with subsequent reconstruction of neighboring pixels using the data from previous frames. This mode requires a high framerate (60+ FPS), otherwise anti-aliasing quality reduces and ghosting effect becomes more pronounced. Recommended for relatively static scenes which contain a lot of light sources and do not have a lot of reflective surfaces (in case of small number of light sources may reduce performance).
Arguments:
0 - disabled (by default)
1 - enabled
render_indirect_lighting_interleaved_color_clamping_intensity
Description:
  • Variable.   Prints the current constant size of the intensity of color clamping for interleaved indirect lighting.
  • Command.   Sets the constant size of the intensity of color clamping for interleaved indirect lighting.
Arguments:
[0.0f; 100.0f] - available range
0.0f - by default
render_indirect_lighting_interleaved_color_clamping_velocity_threshold
Description:
  • Variable.   Prints the current velocity threshold of color clamping for interleaved indirect lighting. The higher the value, the less the ghosting effect. However, increasing the threshold may change the overall image brightness due to excessive color clamping.
  • Command.   Sets the velocity threshold of color clamping for interleaved indirect lighting. The higher the value, the less the ghosting effect. However, increasing the threshold may change the overall image brightness due to excessive color clamping.
Arguments:
[0.0f; 1000.0f] - available range
100.0f - by default
render_indirect_lighting_interleaved_catmull_resampling
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether Catmull-Rom resampling is enabled or not. Catmull-Rom resampling allows you to reduce image blurring when the camera moves forward/backward. It is recommended to disable resampling for low quality presets.
Arguments:
0 - disabled
1 - enabled
render_indirect_lighting_interleaved_color_clamping
Description:
  • Variable.   Prints the current color clamping mode to be used for interleaved rendering of indirect lighting.
  • Command.   Sets the color clamping mode to be used for interleaved rendering of indirect lighting. This mode is used to reduce ghosting effect: higher values increase clamping intensity but may cause flickering on rippled reflective surfaces (as this mode is not so good at the object's edges). When disabled, shadows and reflections have a lag as they are several frames behind.
Arguments:
0 - Disabled
1 - Low
2 - High (by default)
render_indirect_lighting_interleaved_samples
Description:
  • Variable.   Prints the current number of samples for interleaved rendering of indirect lighting defining the number of pixels to be skipped during interleaved rendering of indirect lighting with subsequent reconstruction of neighboring pixels using the data from previous frames (defines the size of reduced lights buffer relative to original size).
  • Command.   Sets the number of samples for interleaved rendering of indirect lighting defining the number of pixels to be skipped during interleaved rendering of indirect lighting with subsequent reconstruction of neighboring pixels using the data from previous frames (defines the size of reduced lights buffer relative to original size).
    • 1 x 2 — half of all pixels are rendered skipping each second line (1.0 * width x 0.5 * height)
    • 2 x 2 — quarter of all pixels are rendered skipping each second line and row (0.5 * width x 0.5 * height)
Arguments:
0 - 1 x 2
1 - 2 x 2 (by default)
render_indirect_diffuse_denoise_threshold_ao
Description:
  • Variable.   Prints the current threshold of the noise reduction value for the indirect diffuse lighting in the areas where the Ambient Occlusion mask is black.
  • Command.   Sets the threshold of the noise reduction value for the indirect diffuse lighting in the areas where the Ambient Occlusion mask is black.
Arguments:
[0.0f; 1.0f] - available range
0.1f - by default
render_indirect_diffuse_temporal_filtering_frames_clamping_velocity_threshold
Description:
Arguments:
[0.0f; inf] - available range
10.0f - by default
render_indirect_diffuse_temporal_filtering_color_clamping_intensity_ao
Description:
  • Variable.   Prints the current intensity of temporal filtering color clamping at zero pixel velocity for Indirect Diffuse in the areas where the Ambient Occlusion mask is black (the Distance buffer).
  • Command.   Sets the intensity of temporal filtering color clamping at zero pixel velocity for Indirect Diffuse in the areas where the Ambient Occlusion mask is black (the Distance buffer).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_indirect_diffuse_temporal_filtering_frame_count_min
Description:
Arguments:
[0.0f; inf] - available range
50.0f - by default
render_indirect_specular_denoise_threshold_ao
Description:
  • Variable.   Prints the current threshold noise reduction value for the indirect specular lighting in the areas where the Ambient Occlusion mask is black.
  • Command.   Sets the threshold noise reduction value for the indirect specular lighting in the areas where the Ambient Occlusion mask is black.
Arguments:
[0.0f; 1.0f] - available range
0.1f - by default
render_indirect_specular_temporal_filtering_color_clamping_intensity_ao
Description:
  • Variable.   Prints the current intensity of temporal filtering color clamping at zero pixel velocity for Indirect Specular in the areas where the Ambient Occlusion mask is black (the Distance buffer).
  • Command.   Sets the intensity of temporal filtering color clamping at zero pixel velocity for Indirect Specular in the areas where the Ambient Occlusion mask is black (the Distance buffer).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_indirect_specular_temporal_filtering_frame_count_min
Description:
Arguments:
[0.0f; inf] - available range
50.0f - by default
render_indirect_specular_temporal_filtering_frames_clamping_velocity_threshold
Description:
Arguments:
[0.0f; inf] - available range
10.0f - by default
render_show_lighting_mode
Description:
  • Variable.   Prints the current visualization of surfaces with the selected lighting mode.
  • Command.   Sets the visualization of surfaces with the selected lighting mode.
Arguments:
0 - disabled (by default)
1 - render objects using static lighting mode
2 - render objects using dynamic lighting mode
3 - render objects using advanced lighting mode
render_ssao
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSAO (Screen Space Ambient Occlusion) 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
1 - enabled (by default)
render_ssao_cavity
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the cavity option for the SSAO (Screen Space Ambient Occlusion) effect is enabled. This option improves (sharpens) the look of junction contours at low resolutions, so it should be used for detail enhancement (small stones, bolts and so on).
    Notice
    When checking the parameter value via API, you'll get the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_ssao_cavity_intensity
Description:
  • Variable.   Prints the current intensity of sharpening of contours for the cavity option (see the render_ssao_cavity).
  • Command.   Sets the intensity of sharpening of contours for the cavity option (see the render_ssao_cavity).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssao_cavity_radius
Description:
  • Variable.   Prints the current size of junction contours area for the cavity option for the SSAO (Screen Space Ambient Occlusion) effect (see the render_ssao_cavity).
  • Command.   Sets the size of junction contours area for the cavity option for the SSAO (Screen Space Ambient Occlusion) effect (see the render_ssao_cavity).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssao_threshold
Description:
  • Variable.   Prints the current threshold value for the SSAO (Screen Space Ambient Occlusion) effect.
  • Command.   Sets the threshold value for the SSAO (Screen Space Ambient Occlusion) effect. It limits SSAO in areas where information cannot be obtained. The higher the value, the less pronounced the effect is.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_ssao_intensity
Description:
  • Variable.   Prints the current intensity of the SSAO (Screen Space Ambient Occlusion) for the scene.
  • Command.   Sets the intensity of the SSAO (Screen Space Ambient Occlusion) for the scene. The intensity value affects brightness of shadows: by the minimum value of 0.0f, the ambient occlusion shadowing is the lightest.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssao_intensity_reflection
Description:
  • Variable.   Prints the current intensity of SSAO (Screen Space Ambient Occlusion) on reflections.
  • Command.   Sets the intensity of SSAO (Screen Space Ambient Occlusion) on reflections.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_gbuffer_lightmap
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if lightmap data is stored in the gbuffer.
Arguments:
0 - disabled
1 - enabled (by default)

Shadows#

Operations on shadows.

render_shadows
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether shadows are rendered.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_alpha_test
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if alpha test is enabled for shadows.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_screen_space
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if screen space shadows are enabled. They provide high-quality penumbra, per-light work, per-pixel detail at any zoom level and infinite visibility distance (when enabled, distant objects can cast shadows next to the horizon). Supports depth cutout parallax. Screen space shadows can be mixed with regular ones.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_translucent_depth
Description:
  • Variable.   Prints the current global translucence depth value defining how deep the light goes through translucent objects shifting the shadow.
  • Command.   Sets the global translucence depth value defining how deep the light goes through translucent objects shifting the shadow. The higher the value, the deeper the light penetrates translucent objects shifting the shadow.
Arguments:
[0.0f; inf] - available range
0.1f - by default
render_shadow_distance
Description:
  • Variable.   Prints the current distance from the camera, beyond which shadows will not be rendered.
  • Command.   Sets the distance from the camera, beyond which shadows will not be rendered.
    Notice
    If this value is greater than the visibility distance for objects the shadows will still be rendered even though the objects themselves are not. Please, pay attention to setting these parameters properly to avoid wasting performance on rendering unnecessary shadows.
Arguments:
[0.0f; inf] - available range
100.0f - by default
render_shadow_distance_scale
Description:
  • Variable.   Prints the current global scale multiplier for shadow distances.
  • Command.   Sets the global scale multiplier for shadow distances. This option enables you to easily increase or decrease shadows rendering performance by changing the scale.
    Notice
    If this value is greater than the scale multiplier for objects (see the render_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
1.0f - by default
render_screen_space_shadow_shafts_mode
Description:
  • Variable.   Prints the current rendering mode for volumetric screen-space shadow shafts.
  • Command.   Sets the rendering mode for volumetric screen-space shadow shafts. Shadow shafts (aka light shafts) can be generated in screen space for the Sun and the Moon to simulate the real world effect of crepuscular rays, or atmospheric shadowing of atmospheric in-scattering. These rays add depth and realism to any scene.
    Notice
    • This effect works for opaque geometry only.
    • It is recommended to use Screen-Space Shadow Shafts with relatively thick haze for visual consistency.
    • Disable this effect for indoor scenes as only world light sources are supported.
Arguments:
0 - Disabled
1 - Sun shadow shafts (by default)
2 - Moon shadow shafts
3 - Sun and Moon shadow shafts
render_screen_space_shadow_shafts_length
Description:
Arguments:
[0.0f; 100.0f] - available range
3.0f - by default
render_screen_space_shadow_shafts_quality
Description:
  • Variable.   Prints the current quality of screen-space shadow shafts.
  • Command.   Sets the quality of screen-space shadow shafts. Defines the number of steps to be used when generating the texture for this effect. Lower quality values may result in noticeable banding effect especially in case of long shadow shafts. Medium quality is usually enough, but you can increase it if shafts are long enough and banding effect becomes noticeable.
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_screen_space_shadow_shafts_resolution
Description:
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (1)
render_shadows_simplified
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the static shadows are enabled for all materials in the scene.
Arguments:
0 - disabled (by default)
1 - enabled
render_shadows_reuse
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the shadow maps of the of the main viewport are reused for other viewports. Shadow maps are normally rendered separately for each viewport when multiple viewports render the scene. It is important as each camera that renders into the viewport has its unique transformation. However, in cases when cameras are close to each other, shadows appear very similar, so for certain viewport and camera configurations you can save resources by enabling this mode — the shadow maps will be rendered only for the main viewport and then used for the others.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_cascadesConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of Parallel Split Shadow Map - world shadow cascades.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_world_shadow_casters
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 that are configured to cast shadows from the current World Light.
Arguments:
0 - disabled (by default)
1 - enabled
render_shadows_filter_mode
Description:
  • Variable.   Prints the current global filtering mode to be used for shadows from all light sources by default.
  • Command.   Sets the global filtering mode to be used for shadows from all light sources by default. This mode determines quality of soft shadows. Higher quality produces smoother shadow edges. When disabled, no filtering is performed and the stair-step effect is clearly seen at the edges of shadows.
    Notice
    You can set filtering mode or disable filtering for each light source individually.
Arguments:
0 - Disabled
1 - Low
2 - Medium (by default)
3 - High
4 - Ultra
render_shadows_filter_noise
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if noise for shadow filtering is enabled. This noise is used for smoothing.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_penumbra_mode
Description:
  • Variable.   Prints the current global quality mode to be used for rendering penumbra from all light sources by default.
  • Command.   Sets the global quality mode to be used for rendering penumbra from all light sources by default. This mode enables simulation of real-world shadows by keeping sharp contact shadows closer to the base and softening the farther the shadow stretches away. Higher values produce softer shadows. When disabled, shadow edges are crisp and sharp (no shadow softness at all).
    Notice
    You can set penumbra quality mode or disable penumbra rendering for each light source individually. But these per-light quality settings are ignored when global quality is set to Disabled.
Arguments:
0 - Disabled
1 - Low (by default)
2 - Medium
3 - High
4 - Ultra
render_shadows_penumbra_noise
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if noise for penumbra rendering is enabled. This noise is used for smoothing.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_world_lerp_cascades
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if linear interpolation of shadow cascades is enabled, making transitions between cascades smoother. This option significantly affects performance, as two shadow maps are rendered in transition areas.
Arguments:
0 - disabled
1 - enabled (by default)
render_shadows_world_cascades_culling_clusters
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether culling of shadow cascades is enabled for Mesh Cluster/Clutter objects. If enabled, the Mesh Cluster/Clutter objects rendered in the nearest cascade won't be rendered again in farther cascades. If disabled, the Mesh Cluster objects rendered in the nearest cascade will also be rendered in all other cascades. In some cases performance may be better if this option is disabled.
Arguments:
0 - disabled (by default)
1 - enabled

Geodetics#

Operations on geodetics.

render_show_geodetic_pivotConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether geodetic pivots are displayed.
Arguments:
0 - disabled (by default)
1 - enabled

Clouds Rendering#

render_clouds_quality_preset
Description:
  • Variable.   Prints the current index of the clouds quality preset used at the moment.
  • Command.   Sets the index of the clouds quality preset used at the moment.
Arguments:
0 - Low (by default)
1 - Medium
2 - High + Interleaved
3 - High
4 - Ultra + Interleaved
5 - Ultra
6 - Extreme + Interleaved
7 - Extreme
8 - Custom
render_clouds_mode
Description:
  • Variable.   Prints the current clouds rendering mode.
  • Command.   Sets the clouds rendering mode. Rendering clouds into the panorama cubemap texture once per frame automatically makes the clouds seen in simple default environment-based reflections making them look more natural for a reduced cost. However, rendering views from inside the clouds is possible in Volumetric mode only.
Arguments:
0 - Volumetric — render volumetric clouds (by default)
1 - Render To Panorama — render clouds to panorama (environment cubemap)
render_clouds_panorama_resolution
Description:
  • Variable.   Prints the current resolution of the panorama cubemap texture.
  • Command.   Sets the resolution of the panorama cubemap texture. Available for Render To Panorama clouds mode.
Arguments:
0 - 128x128
1 - 256x256
2 - 384x384
3 - 512x512
4 - 768x768 (by default)
5 - 1024x1024
6 - 1536x1536
7 - 2048x2048
8 - 4096x4096
render_clouds_panorama_reuse
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the panorama cubemap texture is reused between several viewports. Available for Render To Panorama clouds mode.
Arguments:
0 - disabled (by default)
1 - enabled
render_clouds_accurate_layers_sorting
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if correct sorting of intersecting cloud layers is enabled.
    Notice
    Enabling this feature may reduce raymarching quality as samples shall be distributed among all layers.
Arguments:
0 - disabled (by default)
1 - enabled
render_clouds_depth_based_reconstruction
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if clouds ray-marched depth is used for upsampling the downsampled clouds without obscuring the geometry and reprojection depending on the cloud depth. Recommended for flying through clouds.
    Notice
    Works only with the clouds downsampling rendering mode (see the render_clouds_downsampling_rendering) set to half and/or the clouds interleaved rendering mode (see the render_clouds_interleaved_rendering) set to 2x2.
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_clouds_quality_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_clouds_depth_based_reconstruction_threshold
Description:
  • Variable.   Prints the current depth threshold value for clouds depth-based reconstruction mode (see the render_clouds_depth_based_reconstruction).
  • Command.   Sets the depth threshold value for clouds depth-based reconstruction mode (see the render_clouds_depth_based_reconstruction). This value defines the depth difference starting from which pixels are considered to be related to different surfaces.
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_clouds_quality_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_clouds_distortion_texture
Description:
  • Variable.   Prints the current value indicating which texture type is used for clouds distortion at the moment.
  • Command.   Sets the value indicating which texture type is used for clouds distortion at the moment. This parameter has a significant impact on performance:
    • 2D Texture — more performance-friendly, but may cause an excessive vertical extrusion of clouds.
    • 3D Texture — ensures homogeneous detail distortion and better image quality, but at a higher performance cost.
Arguments:
0 - 2D texture (by default)
1 - 3D texture
render_clouds_downsampling_rendering
Description:
  • Variable.   Prints the current downsampling rendering mode for clouds.
  • Command.   Sets the downsampling rendering mode for clouds. This parameter determines clouds resolution based on current screen resolution.
    Notice
    This parameter has a significant impact on 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_clouds_quality_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_clouds_dynamic_coverage_area
Description:
  • Variable.   Prints the current dynamic coverage area for clouds, in units.
  • Command.   Sets the dynamic coverage area for clouds, in units. This parameter determines visibility distance for coverage of FieldWeather objects.
    Notice
    Increasing dynamic coverage area leads to reduction of quality of FieldWeather coverage texture and loss of details. This effect can be mitigated by increasing dynamic coverage resolution using the corresponding command (see the render_clouds_dynamic_coverage_resolution).
Arguments:
[10.0f; 400000.0f] - available range
10000.0f - by default
render_clouds_dynamic_coverage_resolution
Description:
  • Variable.   Prints the current the value defining the size of the square dynamic coverage resolution texture for clouds, in pixels.
  • Command.   Sets the the value defining the size of the square dynamic coverage resolution texture for clouds, in pixels. This parameter determines the quality of dynamic coverage texture for FieldWeather objects. Higher values make it possible to preserve texture details at high distances.
    Notice
    Increased resolution significantly affects performance.
Arguments:
[16; 8192] - available range
256 - by default
render_clouds_far_clipping
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if far-plane clipping is used for clouds visibility.

    Controlling clouds visibility by increasing the far-plane distance significantly affects performance in many aspects (dynamic Environment Probes, etc.). You can disable this option when necessary as an optimization.

Arguments:
0 - disabled
1 - enabled (by default)
render_clouds_ground_shadows
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of shadows from the clouds on the ground is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_clouds_3d_texture_horizontal_resolution
Description:
  • Variable.   Prints the current horizontal resolution for the 3D texture to be used for clouds rendering.
  • Command.   Sets the horizontal resolution for the 3D texture to be used for clouds rendering.
    Notice
    Setting too high resolution may significantly affect performance, so adjust it wisely.
Arguments:
0 - 64
1 - 128
2 - 256 (by default)
3 - 512
4 - 1024
5 - 2048
render_clouds_3d_texture_vertical_resolution
Description:
  • Variable.   Prints the current vertical resolution for the 3D texture to be used for clouds rendering.
  • Command.   Sets the vertical resolution for the 3D texture to be used for clouds rendering.
    Notice
    Setting too high resolution may significantly affect performance, so adjust it wisely.
Arguments:
0 - 32
1 - 64
2 - 128
3 - 256 (by default)
4 - 512
render_clouds_interleaved_rendering
Description:
  • Variable.   Prints the current interleaved rendering mode for clouds.
  • Command.   Sets the interleaved rendering mode for clouds. In cases when clouds are viewed from the ground, or from above (at significant distance) and viewer's velocities are less than 200 units per second, this parameter can be used to provide a significant gain in 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_clouds_quality_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - Disabled (by default)
1 - 2×2
2 - 4×4
3 - 8×8
render_clouds_interleaved_rendering_temporal
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if temporal accumulation of noises for interleaved sampling for clouds is enabled.
    Notice
    Works only when the clouds interleaved rendering mode (see the render_clouds_interleaved_rendering) is set to 2x2.
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_clouds_quality_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_clouds_lighting_cone_radius
Description:
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_clouds_lighting_quality
Description:
  • Variable.   Prints the current lighting quality for clouds.
  • Command.   Sets the lighting quality for clouds. This parameter determines the number of samples used to calculate lighting for clouds. The following values are available:
    • Low — 1 sample, low quality
    • Medium — 3 samples, medium quality
    • High — 5 samples, high quality
    • Ultra — 6 samples, ultra quality
    Notice
    This parameter has a significant impact on performance. Therefore, it is recommended to use low settings, when possible.
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_clouds_quality_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_clouds_lighting_samples_distribution
Description:
  • Variable.   Prints the current value that controls distribution of samples for clouds lighting.
  • Command.   Sets the value that controls distribution of samples for clouds lighting. Can be used to keep small details for long shadows when the lighting trace length value (see the render_clouds_lighting_tracelength) is high.
Arguments:
[0.001f; 5.0f] - available range
1.0f - by default
render_clouds_lighting_tracelength
Description:
Arguments:
[1.0f; 2048.0f] - available range
230.0f - by default
render_clouds_noise_step
Description:
  • Variable.   Prints the current value of the noise step parameter for clouds.
  • Command.   Sets the value of the noise step parameter for clouds. This parameter determines the amount of jitter in the areas within clouds, that is used to reduce banding effect due to insufficient number of 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_clouds_quality_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.3f - by default
render_clouds_noise_step_skip
Description:
  • Variable.   Prints the current value of the noise step skip parameter for clouds.
  • Command.   Sets the value of the noise step skip parameter for clouds. This parameter determines the amount of jitter in the areas between clouds, that is used to reduce banding effect due to insufficient number of 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_clouds_quality_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.3f - by default
render_clouds_noise_iterations
Description:
  • Variable.   Prints the current value of the noise iterations parameter for clouds.
  • Command.   Sets the value of the noise iterations parameter for clouds. This parameter determines the amount of jitter in the areas within clouds, that is used to reduce banding effect due to insufficient number of 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_clouds_quality_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.1f - by default
render_clouds_noise_lighting
Description:
  • Variable.   Prints the current value of the noise lighting parameter for the clouds.
  • Command.   Sets the value of the noise lighting parameter for the clouds. This parameter determines the amount of jitter for tracing steps of lighting calculation, that is used to reduce banding effect due to insufficient number of 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_clouds_quality_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.3f - by default
render_clouds_rounded
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if cloud layers are to be curved to make them look more natural imitating planet's curvature.
Arguments:
0 - disabled
1 - enabled (by default)
render_clouds_rounded_planet_radius
Description:
  • Variable.   Prints the current radius of the planet to be used for clouds curving.
  • Command.   Sets the radius of the planet to be used for clouds curving. Visual curving can be used to make clouds look more natural imitating planet's curvature.
Arguments:
[100.0f; inf] - available range
200000.0f - by default
render_clouds_samples_count
Description:
  • Variable.   Prints the current number of samples used for clouds rendering.
  • Command.   Sets the number of samples used for clouds rendering. The higher the value, the less noise in clouds rendering. The following values are available:
    • Low — 1 sample, low quality
    • Medium — 3 samples, medium quality
    • High — 5 samples, high quality
    • Ultra — 6 samples, ultra quality
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_clouds_quality_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 (2)
render_clouds_sampling_quality
Description:
  • Variable.   Prints the current sampling quality for clouds.
  • Command.   Sets the sampling quality for clouds. This parameter sets the number of noise samples that affects the cloud shape processing quality. The higher the value, the less are visual artifacts. The following modes are available:
    • Low — 1 sample, low quality (higher cloud density)
    • Medium — 3 samples, medium quality
    • High — 5 samples, high quality
    • Ultra — 6 samples, ultra quality (lower density, the clouds are softer)
    Notice
    Visual difference between low and ultra quality is not significant. Therefore, it is recommended to use low settings, when possible, to gain 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_clouds_quality_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_clouds_soft_intersection
Description:
Arguments:
[0.0f; 100000.0f] - available range
100.0f - by default
render_clouds_step_accuracy
Description:
  • Variable.   Prints the current accuracy of ray marching steps.
  • Command.   Sets the accuracy of ray marching steps. This parameter enables you to improve the visual look of clouds when viewed from inside a cloud layer. It reduces the noise of lighting and clouds shape for long ray marching distances, adds some noise-based blur to a sharp border at the bottom sphere of the cloud layer (rounded) and removes popping effect when leaving a rounded cloud layer. Higher values provide more accurate form and less noise, while lower ones gain more 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_clouds_quality_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_clouds_transparent_order
Description:
  • Variable.   Prints the current rendering order for clouds relative to transparent objects (except water).
  • Command.   Sets the rendering order for clouds relative to transparent objects (except water).
    • Render Before Transparent — render clouds before all transparent objects (except water).
    • Render After Transparent — render clouds after all transparent objects (except water).
    • Sort Transparent — enable rough sorting for transparent objects relative to clouds (below the lowest cloud layer base -> inside the clouds -> above the highest cloud layer top).
Arguments:
0 - Render Before Transparent (by default)
1 - Render After Transparent
2 - Sort Transparent

Terrain Rendering#

The commands described below are intended for configuring Landscape Terrain object (the ObjectLandscapeTerrain class).

Warning
Changing some of the parameters below triggers reloading of the Landscape Terrain graphic data, so it's not recommended to do it at run time.
render_landscape_cache_cpu_size
Description:
  • Variable.   Prints the current CPU cache size to be used for landscape terrain rendering, in percentage of the total memory.
  • Command.   Sets the CPU cache size to be used for landscape terrain rendering, in percentage of the total memory. CPU cache size affects intersections, physics, streaming, etc. The size of CPU cache depends on the scene.
Arguments:
[1; 100] - available range
10 - by default
render_landscape_cache_cpu_prefetch_radius
Description:
  • Variable.   Prints the current radius within which heights data is pre-loaded into memory for correct calculation of collisions and intersections.
  • Command.   Sets the radius within which heights data is pre-loaded into memory for correct calculation of collisions and intersections.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_landscape_cache_gpu_size
Description:
  • Variable.   Prints the current GPU cache size to be used for landscape terrain rendering, in percentage of the total GPU memory.
  • Command.   Sets the GPU cache size to be used for landscape terrain rendering, in percentage of the total GPU memory. GPU cache is used to accumulate tiles, that are visible to the camera, before streaming them to the megatexture.
    Notice
    High-resolution maps require larger cache capacity.
Arguments:
[1; 100] - available range
4 - by default
render_landscape_cache_gpu_life_time
Description:
  • Variable.   Prints the current lifetime of GPU cache used for Landscape Terrain rendering, in frames.
  • Command.   Sets the lifetime of GPU cache used for Landscape Terrain rendering, in frames.
Arguments:
[1; 60] - available range
4 - by default
render_landscape_operations_per_frame
Description:
  • Variable.   Prints the current maximum number of Landscape texture draw operations (asyncTextureDraw) that can be performed per frame.
  • Command.   Sets the maximum number of Landscape texture draw operations (asyncTextureDraw) that can be performed per frame.
Arguments:
[1; 1000] - available range
10 - by default
render_landscape_terrain_culling_frustum_aggressive
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if frustum culling optimization is enabled for the Landscape Terrain. When enabled, the number of culled polygons increases thereby increasing performance. In case of any issues with polygons rendering, try disabling this option (however, note that performance may drop).
Arguments:
0 - disabled
1 - enabled (by default)
render_landscape_terrain_culling_by_depth
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if culling by depth is enabled. Keep this option enabled to get the performance higher due to culling of tiles occluded by geometry and Landscape Terrain itself.
Arguments:
0 - disabled
1 - enabled (by default)
render_landscape_terrain_culling_depth_resolution
Description:
  • Variable.   Prints the current resolution of the buffer used for culling by depth.
  • Command.   Sets the resolution of the buffer used for culling by depth.
Arguments:
[4; 2048] - available range
64 - by default
render_landscape_terrain_culling_padding_triangles
Description:
  • Variable.   Prints the current padding between LODs of tessellated polygons.
  • Command.   Sets the padding between LODs of tessellated polygons.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_landscape_terrain_culling_padding_patch_gpu
Description:
  • Variable.   Prints the current padding between LODs of patches culled on GPU.
  • Command.   Sets the padding between LODs of patches culled on GPU.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_landscape_terrain_culling_padding_patch_cpu
Description:
  • Variable.   Prints the current padding between LODs of patches culled on CPU.
  • Command.   Sets the padding between LODs of patches culled on CPU.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_landscape_terrain_culling_patch_batching
Description:
  • Variable.   Prints the current number of culling patches of Landscape Terrain processed in a batch.
  • Command.   Sets the number of culling patches of Landscape Terrain processed in a batch. The higher this value, the more patches will be checked for visibility on CPU at once.
Arguments:
[1; 64] - available range
16 - by default
render_landscape_terrain_culling_patch_resolution_gpu
Description:
  • Variable.   Prints the current number of subdivisions for patches of Landscape Terrain culled on the GPU side that are to be tessellated.
  • Command.   Sets the number of subdivisions for patches of Landscape Terrain culled on the GPU side that are to be tessellated. By lowering this value you reduce the load on CPU, by increasing it you reduce the load on GPU. The point is to find a trade-off between loads in the given conditions on the target hardware.
Arguments:
[4; 64] - available range
32 - by default
render_landscape_terrain_culling_patch_resolution_cpu
Description:
  • Variable.   Prints the current number of subdivisions for patches of Landscape Terrain culled on the CPU side that are to be passed to GPU.
  • Command.   Sets the number of subdivisions for patches of Landscape Terrain culled on the CPU side that are to be passed to GPU. The lowest value of 2 corresponds to no subdivisions at all, i.e. all patched will be culled on the CPU side. By increasing this value you can reduce the load on CPU as more patches will be checked for visibility on the GPU side.
Arguments:
[2; 64] - available range
2 - by default
render_landscape_terrain_culling_oblique_frustum
Description:
  • Variable.   Prints the current multiplier for culling of tessellation patches of the Landscape Terrain beyond the oblique frustum plane.
  • Command.   Sets the multiplier for culling of tessellation patches of the Landscape Terrain beyond the oblique frustum plane. Higher values result in more patches culled.
Arguments:
[0.0f; 1.0f] - available range
0.9f - by default
render_landscape_terrain_culling_map
Description:
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_landscape_terrain_detail_compression
Description:
  • Variable.   Prints the current mode of detail textures compression.
  • Command.   Sets the mode of detail textures compression. Compressed detail textures take less video memory.
Arguments:
0 - Disabled
1 - Fast Compression (by default)
2 - High Quality
render_landscape_terrain_detail_resolution_additional_mask
Description:
Arguments:
0 - 64×64
1 - 128×128
2 - 256×256
3 - 512×512
4 - 1024×1024 (by default)
5 - 2048×2048
6 - 4096×4096
7 - 8192×8192
8 - 16384×16384
render_landscape_terrain_detail_resolution_albedo
Description:
Arguments:
0 - 64×64
1 - 128×128
2 - 256×256
3 - 512×512
4 - 1024×1024 (by default)
5 - 2048×2048
6 - 4096×4096
7 - 8192×8192
8 - 16384×16384
render_landscape_terrain_detail_resolution_height
Description:
Arguments:
0 - 64×64
1 - 128×128
2 - 256×256
3 - 512×512
4 - 1024×1024 (by default)
5 - 2048×2048
6 - 4096×4096
7 - 8192×8192
8 - 16384×16384
render_landscape_terrain_mask_dithering
Description:
  • Variable.   Prints the current global dither amount multiplier to be used for rendering details of the Landscape Terrain.
  • Command.   Sets the global dither amount multiplier to be used for rendering details of the Landscape Terrain. Dithering enables reduction of graphical artefacts in case of increased Mask Contrast values set for a detail. This is a global multiplier for dithering values set for each detail mask.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_landscape_terrain_geometry_detail_max_height
Description:
  • Variable.   Prints the current maximum height for detail displacement clamping.
  • Command.   Sets the maximum height for detail displacement clamping. Adjust this value to the highest height value used in details in case of artifacts of stepped geometry caused by insufficient bit depth.
Arguments:
[0.0f; 10.0f] - available range
0.5f - by default
render_landscape_terrain_geometry_holes
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if decal-based holes for the Landscape Terrain are enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_landscape_terrain_geometry_polygon_size
Description:
  • Variable.   Prints the current size of Landscape Terrain polygons defining the maximum allowed density of Landscape Terrain geometry.
  • Command.   Sets the size of Landscape Terrain polygons defining the maximum allowed density of Landscape Terrain geometry.
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_landscape_terrain_geometry_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1000.0f] - available range
0.01f - by default
render_landscape_terrain_geometry_progression
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_landscape_terrain_geometry_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 50.0f] - available range
1.5f - by default
render_landscape_terrain_geometry_subpixel_reduction
Description:
  • Variable.   Prints the current minimum ratio between the polygon size (in screen space) to the size of an area in the viewport for skipping polygons rendering (the ones having a lower ratio will be removed).
  • Command.   Sets the minimum ratio between the polygon size (in screen space) to the size of an area in the viewport for skipping polygons rendering (the ones having a lower ratio will be removed).
    Notice
    Setting too high values may cause small but noticeable visual artifacts when the camera moves.
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_landscape_terrain_geometry_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 50.0f] - available range
6.0f - by default
render_landscape_terrain_geometry_preset
Description:
  • Variable.   Prints the current index of the Landscape Terrain geometry preset used at the moment.
  • Command.   Sets the index of the Landscape Terrain geometry preset used at the moment.
    Notice
    Presets override user-defined custom settings. When any preset other than Custom is active, modification of the parameters via API has no effect. The parameter value set via the last API call shall be used only when the Custom preset is active. When checking the current parameter value via API you'll get the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Extreme
5 - Custom
render_landscape_terrain_streaming_preset
Description:
  • Variable.   Prints the current index of the Landscape Terrain streaming preset used at the moment.
  • Command.   Sets the index of the Landscape Terrain streaming preset used at the moment.
    Notice
    Presets override user-defined custom settings. When any preset other than Custom is active, modification of the parameters via API has no effect. The parameter value set via the last API call shall be used only when the Custom preset is active. When checking the current parameter value via API you'll get the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Extreme
5 - Custom
render_landscape_terrain_streaming_threads
Description:
  • Variable.   Prints the current number of threads used for streaming.
  • Command.   Sets the number of threads used for streaming.
Arguments:
[0; 32] - available range
1 - by default
render_landscape_terrain_streaming_per_lods
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if streaming per LODs (MIP maps) is enabled. Disable this option to make streaming faster by skipping loading of intermediate MIP-levels for textures.
Arguments:
0 - disabled
1 - enabled (by default)
render_landscape_terrain_texel_size
Description:
  • Variable.   Prints the current texel size of the Landscape Terrain render textures representing the maximum level of detail for the albedo, normal, and height components of the Landscape Terrain.
  • Command.   Sets the texel size of the Landscape Terrain render textures representing the maximum level of detail for the albedo, normal, and height components of the Landscape Terrain.
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_landscape_terrain_streaming_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0001f; 1.0f] - available range
0.001f - by default
render_landscape_terrain_visible_distance
Description:
Arguments:
[0.0f; inf] - available range
30000.0f - by default
render_landscape_terrain_vt_detail_level_by_angle
Description:
  • Variable.   Prints the current value indicating detail level reduction depending on the inclination of the the Landscape Terrain polygons relative to viewing direction.
  • Command.   Sets the value indicating detail level reduction depending on the inclination of the the Landscape Terrain polygons relative to viewing direction. Can be used to reduce streaming load and memory consumption. The value of 1 corresponds to the pixel-to-pixel quality, and lower values decrease it.
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_landscape_terrain_streaming_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.95f - by default
render_landscape_terrain_vt_filtering
Description:
  • Variable.   Prints the current filtering mode for the Landscape Terrain textures.
  • Command.   Sets the filtering mode for the Landscape Terrain textures. The following values are available:
    • Low — use the lower mip-level
    • Medium — use the higher mip-level
    • High — linearly interpolate between adjacent mip-levels
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_landscape_terrain_streaming_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - Low
1 - Medium (by default)
2 - High
render_landscape_terrain_vt_hash_size
Description:
  • Variable.   Prints the current upper limit for the hash function used to determine tiles of Landscape Terrain.
  • Command.   Sets the upper limit for the hash function used to determine tiles of Landscape Terrain. The value must be high enough to cover all variety of world-space positions of tiles being used and streamed.
Arguments:
[1000; 5000000] - available range
1000000 - by default
render_landscape_terrain_vt_hash_number_mistakes
Description:
  • Variable.   Prints the current number of mistakes of the hash function used in Landscape Terrain data streaming.
  • Command.   Sets the number of mistakes of the hash function used in Landscape Terrain data streaming. This value actually represents the number of iterations to compute a new unique hash value that determines a tile being streamed. Too low values may introduce collisions and, therefore, wrong terrain data at certain areas.
Arguments:
[1; 32] - available range
2 - by default
render_landscape_terrain_vt_memory_size
Description:
  • Variable.   Prints the current value defining memory consumption for the Landscape Terrain textures.
  • Command.   Sets the value defining memory consumption for the Landscape Terrain textures. The value is interpreted as follows:
    • 0.0f - 3072×3072 (~200 MB of VRAM)
    • 1.0f - 16384×16384 (~3.1 GB of VRAM)
    • 0.4f - 8192×8192 (~860 MB of VRAM)
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_landscape_terrain_streaming_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.4f - by default
render_landscape_terrain_vt_target_resolution
Description:
  • Variable.   Prints the current target resolution (width x height) for the Landscape Terrain, in pixels.
  • Command.   Sets the target resolution (width x height) for the Landscape Terrain, in pixels.
Arguments:
1344 х 756 - (default)
render_landscape_terrain_vt_sampler_feedback_screen_resolution
Description:
  • Variable.   Prints the current resolution of the screen buffer used to detect visible tiles and what MIP-levels to be loaded.
  • Command.   Sets the resolution of the screen buffer used to detect visible tiles and what MIP-levels to be loaded.
Arguments:
0 - Quarter
1 - Half (by default)
2 - Full
render_landscape_terrain_vt_sampler_feedback_buffer_resolution
Description:
  • Variable.   Prints the current resolution of the buffer used to transfer data about tiles and what MIP-levels to be loaded.
  • Command.   Sets the resolution of the buffer used to transfer data about tiles and what MIP-levels to be loaded.
Arguments:
From 1x1 to 1024x1024 Default: 80x60
render_landscape_terrain_vt_tiles_load_per_frame
Description:
  • Variable.   Prints the current number of Landscape Terrain tiles loaded per frame.
  • Command.   Sets the number of Landscape Terrain tiles loaded per frame. You can decrease the value of this parameter to reduce spikes, but in this case streaming becomes slower and more noticeable.
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_landscape_terrain_streaming_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_landscape_terrain_vt_tiles_reload_per_frame
Description:
  • Variable.   Prints the current number of tiles to be reloaded per frame after applying changes to the Landscape Terrain surface.
  • Command.   Sets the number of tiles to be reloaded per frame after applying changes to the Landscape Terrain surface.
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_landscape_terrain_streaming_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_landscape_terrain_vt_tiles_update_per_frame
Description:
  • Variable.   Prints the current number of tiles passed to the virtual texture of the Landscape Terrain each frame.
  • Command.   Sets the number of tiles passed to the virtual texture of the Landscape Terrain each frame.
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_landscape_terrain_streaming_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 256] - available range
60 - by default

Notice
The commands described below affect only terrain (the ObjectTerrainGlobal class).
render_terrain_global_anisotropy
Description:
  • Variable.   Prints the current global terrain texture anisotropy level (degree of anisotropic filtering).
  • Command.   Sets the global terrain texture anisotropy level (degree of anisotropic filtering). Anisotropy for the global terrain has a huge impact for the performance if terrain has a lot of tiled detail materials as anisotropy filtering for the terrain is much slower than for the other objects.
Arguments:
0 - anisotropy level 1
1 - anisotropy level 2
2 - anisotropy level 4 (by default)
3 - anisotropy level 8
4 - anisotropy level 16
render_terrain_global_displacement
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if displacement mapping is enabled for the Global Terrain.
Arguments:
0 - disabled (by default)
1 - enabled
render_terrain_global_displacement_normal
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if displacement mapping for the Global Terrain rendering uses normals.
Arguments:
0 - disabled (by default)
1 - enabled
render_terrain_global_holes
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if decal-based holes are enabled for the global terrain.
Arguments:
0 - disabled (by default)
1 - enabled
render_terrain_global_triplanar
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if triplanar texture mapping is enabled for the Global Terrain. If disabled, planar UV-mapping is used.
Arguments:
0 - disabled (by default)
1 - enabled

ObjectWaterGlobal Rendering#

Notice
The commands described below affect only global water (the ObjectWater class).
render_water_anisotropy
Description:
  • Variable.   Prints the current water texture anisotropy level.
  • Command.   Sets the water texture anisotropy level. The following values are available:
    • 1x — anisotropy level 1
    • 2x — anisotropy level 2
    • 4x — anisotropy level 4
    • 8x — anisotropy level 8
    • 16x — anisotropy level 16
Arguments:
0 - 1x
1 - 2x (by default)
2 - 4x
3 - 8x
4 - 16x
render_water_environment_probes
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of environment probes on the water surface is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_voxel_probes
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if voxel probes are enabled for water rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_planar_probes
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of Planar Reflection Probes on the water surface is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_lights
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 on the water surface is enabled.
    Notice
    The option doesn't affect the World Light source.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_opacity_depth
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if depth data for water is written to the opacity buffer.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_refraction_quality
Description:
  • Variable.   Prints the current quality of water refraction.
  • Command.   Sets the quality of water refraction.
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (2)
render_water_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 for water.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_ssr_quality
Description:
  • Variable.   Prints the current resolution of water SSR (Screen Space Reflections).
  • Command.   Sets the resolution of water SSR (Screen Space Reflections).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_water_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 for the water SSR (Screen Space Reflections). This option reduces visual artifacts by increasing accuracy of the last step.
Arguments:
0 - disabled (by default)
1 - enabled
render_water_shafts
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of underwater shafts is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_shoreline_wetness
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the wetness effect for objects near the shoreline is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_geometry_preset
Description:
  • Variable.   Prints the current index of the Global Water geometry preset used at the moment. To customize the Global Water geometry preset options at run time you should activate the Custom preset:
  • Command.   Sets the index of the Global Water geometry preset used at the moment. To customize the Global Water geometry preset 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_water_visible_distance
Description:
  • Variable.   Prints the current maximum visibility distance for the Global Water.
  • Command.   Sets the maximum visibility distance for the Global Water. The water is visible, as long as the distance between the camera and the water object does not exceed this value.
Arguments:
[0.0f; inf] - available range
30000.0f - by default
render_water_geometry_polygon_size
Description:
  • Variable.   Prints the current size of Global Water polygons.
  • Command.   Sets the size of Global Water polygons. The value defines the maximum allowed density of Global Water geometry. If the polygon size is large, small waves will be lost. It is better to set this parameter to about 1/3 or 1/4 of the smallest wavelength.
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_water_geometry_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1000.0f] - available range
0.01f - by default
render_water_geometry_progression
Description:
  • Variable.   Prints the current progression of Global Water geometry tessellation.
  • Command.   Sets the progression of Global Water geometry tessellation.
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_water_geometry_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 50.0f] - available range
1.5f - by default
render_water_geometry_fade_lods
Description:
  • Variable.   Prints the current intensity of fading between levels of Global Water geometry tessellation.
  • Command.   Sets the intensity of fading between levels of Global Water geometry tessellation. This value can be increased to remove sharp edges between areas with different geometry density.
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_water_geometry_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_water_geometry_subpixel_reduction
Description:
  • Variable.   Prints the current minimum ratio of a polygon size (in screen space) to the size of an area seen in the viewport.
  • Command.   Sets the minimum ratio of a polygon size (in screen space) to the size of an area seen in the viewport. If the ratio calculated for the polygon is less than this value, such polygon will be removed.
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_water_geometry_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 50.0f] - available range
6.0f - by default
render_water_culling_aggressive
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if frustum culling optimization is enabled for the Global Water. When enabled, the number of culled polygons increases thereby increasing performance. In case of any issues with polygons rendering, try disabling this option (however, note that performance may drop).
Arguments:
0 - disabled
1 - enabled (by default)
render_water_culling_frustum_padding
Description:
  • Variable.   Prints the current value, by which the borders of the current frustum are increased.
  • Command.   Sets the value, by which the borders of the current frustum are increased. Frustum culling is performed for the frustum of the increased size. By the maximum value of 1, the frustum borders will be increased by the size of the current frustum.
Arguments:
[0.0f; 1.0f] - available range
0.1f - by default
render_water_culling_oblique_frustum
Description:
  • Variable.   Prints the current multiplier for the size of viewing frustum used for culling polygons of Global Water object beyond the oblique frustum plane.
  • Command.   Sets the multiplier for the size of viewing frustum used for culling polygons of Global Water object beyond the oblique frustum plane. The higher the value, the more patches will be culled.
Arguments:
[0.0f; 1.0f] - available range
0.9f - by default
render_water_waterline_accuracy
Description:
  • Variable.   Prints the current quality of underwater and waterline determination.
  • Command.   Sets the quality of underwater and waterline determination. Use high quality only if you need to submerge underwater (to see the waterline) and at medium and high Beaufort values.
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (0)

Output Modes#

render_viewport_mode
Description:
  • Variable.   Prints the current viewport rendering mode.
  • Command.   Sets the viewport rendering mode. The following modes are available:
    • Default — default rendering mode.
    • Curved Panorama 180 — 180-degree panorama with curved edges.
    • Curved Panorama 360 — 360-degree panorama with curved edges.
    • Linear Panorama 180 — 180-degree linear panorama without distortion at the edges.
    • Linear Panorama 360 — 360-degree linear panorama without distortion at the edges.
    • Panorama Fisheye Orthographic — orthographic spherical panorama (fisheye) with an adjustable Field of View.
    • Panorama Fisheye Equidistant — equidistant (tru-theta or f-theta) spherical panorama (fisheye) with an adjustable Field of View.
    • Panorama Fisheye Stereographic — stereographic spherical panorama (fisheye) with an adjustable Field of View.
    • Panorama Fisheye Equisolid — equisolid (equal-area) spherical panorama (fisheye) with an adjustable Field of View.
    • Anaglyph — stereo mode that is viewed with red-cyan anaglyph glasses.
    • Interlaced — stereo mode that is used with interlaced stereo monitors and polarized 3D glasses.
    • Horizontal — horizontal stereo mode.
    • Vertical — vertical stereo mode.
    Notice
    If the panoramic rendering is enabled, underwater shafts and water line effects will be disabled.
Arguments:
0 - Default (by default)
1 - Curved Panorama 180
2 - Curved Panorama 360
3 - Linear Panorama 180
4 - Linear Panorama 360
5 - Panorama Fisheye Orthographic
6 - Panorama Fisheye Equidistant
7 - Panorama Fisheye Stereographic
8 - Panorama Fisheye Equisolid
9 - Anaglyph
10 - Interlaced
11 - Horizontal
12 - Vertical
render_panorama_fisheye_fov
Description:
  • Variable.   Prints the current Field of View (in degrees) for the panoramic viewport mode selected at the moment.
  • Command.   Sets the Field of View (in degrees) for the panoramic viewport mode selected at the moment.
    Notice
    Available only when the viewport rendering mode (see the render_viewport_mode) is set to one of the fisheye panorama modes (5-8).
Arguments:
[0; 360] - available range
0 - by default
render_stereo_hidden_area
Description:
  • Variable.   Prints the current culling mode for pixels that are not visible in VR mode.
  • Command.   Sets the culling mode for pixels that are not visible in VR mode. One of the following values:
    • 0 - hidden area culling is disabled (by default).
    • 1 - OpenVR-based culling mode. Culling is performed using meshes returned by OpenVR.
      Notice
      Culling result depends on HMD used.
    • 2 - Custom culling mode. Culling is performed using mesehes returned by OpenVR and an oval or circular mesh determined by custom adjustable parameters (see the render_stereo_hidden_area_transform).
    This parameter is used for performance optimization.
Arguments:
0 - disabled (by default)
1 - OpenVR-based culling mode
2 - Custom culling mode
render_stereo_hidden_area_transform
Description:
  • Variable.   Prints the current size and offset parameters for a new oval or circular mesh to be used for culling pixels, that are not visible in VR mode.
  • Command.   Sets the size and offset parameters for a new oval or circular mesh to be used for culling pixels, that are not visible in VR mode. A four-component vector (X, Y, Z, W), that determines an area to be used for exposure calculation, when culling of pixels, that are not visible in VR mode, is enabled:
    • First two components (X, Y) - sizes along the X and Y axes respectively.
    • Second two components (Z, W) - offset values along the X and Y axes respectively.
      Notice
      These components are ignored whenthe hidden area culling mode (see the render_stereo_hidden_area) is set to 1
    All components are specified within the [0.0f, 1.0f] range
Arguments:
(1.0f, 1.0f, 0.0f, 0.0f) - default value
render_stereo_hidden_area_exposure_transform
Description:
  • Variable.   Prints the current area to be used for exposure calculation, when culling of pixels that are not visible in VR mode (see the render_stereo_hidden_area) is enabled.
  • Command.   Sets the area to be used for exposure calculation, when culling of pixels that are not visible in VR mode (see the render_stereo_hidden_area) is enabled. Correction of this area is used to avoid visual artefacts when clipped pixels affect exposure in visible areas. A four-component vector (X, Y, Z, W):
    • First two components (X, Y) - sizes along the X and Y axes respectively.
    • Second two components (Z, W) - offset values along the X and Y axes respectively.
      Notice
      These components are ignored when the hidden area culling mode (see the render_stereo_hidden_area) is set to 1
    All components are specified within the [0.0f, 1.0f] range.
Arguments:
(0.6f, 0.6f, 0.0f, 0.0f) - default value

Other Settings#

render_multithreaded
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the multithreaded rendering mode is enabled (DX12 only).
Arguments:
0 - disabled
1 - enabled (by default)
render_multithreaded_editor
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the multithreaded rendering mode in the Editor is enabled (DX12 only).
Arguments:
0 - disabled (by default)
1 - enabled
render_latency
Description:
  • Variable.   Prints the current maximum number of back buffer frames that a driver is allowed to queue for rendering.
  • Command.   Sets the maximum number of back buffer frames that a driver is allowed to queue for rendering. The buffers are used for GPU load optimization: in certain cases several command buffers (frames) can be processed by GPU at once increasing the Waiting GPU time for one frame and having zero Waiting GPU time for the next ones. Thus, GPU avoids rendering spikes, but increased Waiting GPU time will cause a spike in application logic, in case when the logic is bound to duration of a single frame. Frame latency is the number of frames that are allowed to be stored in a queue before submission for rendering. Latency is often used to control how the CPU chooses between responding to user input and frames that are in the render queue. In certain cases (high GPU load, VSYNC usage) it may be required to queue more frames of data, it is also beneficial for applications with no user input (e.g., video playback).
    Notice
    Values 1-3 are available for DirectX only.
Arguments:
0 - sequential rendering CPU-GPU-CPU-GPU...
1 - 1 buffer (by default)
2 - 2 buffers
3 - 3 buffers
render_occlusion_queries
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if additional hardware occlusion query test before sending data to GPU is enabled. This test is performed for all objects with the Culled by occlusion query flag set.
Arguments:
0 - disabled
1 - enabled (by default)
render_occlusion_queries_num_frames
Description:
  • Variable.   Prints the current number of frames for additional hardware occlusion query test performed before sending data to GPU.
  • Command.   Sets the number of frames for additional hardware occlusion query test performed before sending data to GPU. Make sure that the additional hardware occlusion query test (see the render_occlusion_queries) is enabled.
Arguments:
[0; 1024] - available range
5 - by default
render_virtual_resolution
Description:
  • Variable.   Prints the current virtual screen resolution.
  • Command.   Sets the virtual screen resolution. This option can be used to render video with high resolution (e.g. 8K) regardless of monitor's resolution.
Arguments:
-1; -1 - default value
render_max_fps
Description:
  • Variable.   Prints the current maximum FPS value, to which rendering FPS is to be clamped.
  • Command.   Sets the maximum FPS value, to which rendering FPS is to be clamped.
    0 - disables FPS clamping. Both VSync, and Max FPS are actually about an additional idle period at the end of the frame. In case of VSync the Engine shall wait for the monitor to draw the whole image, while Max FPS enables you to specify any value for the delay (even a fractional, like 24.5). This clamping limit can be used for both debugging purposes and in the final build as well enabling you to smooth an unstable "jigsaw" framerate. For example, in case FPS jumps between 45 and 90, setting Max FPS to 45 may significantly improve your application's response visually.
Arguments:
[0.0f; inf] - available range
0.0f - by default

Renderers#

OpenAL Settings#

Operations on the OpenAL API.

al_sound_renderer
Description:
  • Command. Prints the information on the sound card.
al_sound_vendor
Description:
  • Command. Prints the manufacturer of the OpenAL driver.
al_sound_version
Description:
  • Command. Prints the version of the OpenAL driver.
al_sound_extensions
Description:
  • Command. Prints the available OpenAL sound extensions.
alc_sound_extensions
Description:
  • Command. Prints OpenAL context sound extensions.
al_sound_skip_errors
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables skipping of OpenAL errors.
Arguments:
0 - disabled (by default)
1 - enabled

Plugins#

Operations on external plugins.

plugin_load
Description:
  • Command. Loads an external plugin.
Arguments:
External plugin name
plugin_reload
Description:
  • Command. Reloads an external plugin.
Arguments:
External plugin name
plugin_unload
Description:
  • Command. Quits and unloads an external plugin.
Arguments:
External plugin name

Bake Lighting#

Operations on the Bake Lighting tool.

bake_lighting_bounces
Description:
Arguments:
[1; 32] - available range
1 - by default
bake_lighting_samples_per_frame
Description:
  • Variable.   Prints the current number of voxels computed and visualized per single frame during bake lighting process (higher values cause longer UI response, but speed up calculations).
  • Command.   Sets the number of voxels computed and visualized per single frame during bake lighting process (higher values cause longer UI response, but speed up calculations).
Arguments:
[1; 500] - available range
10 - by default
bake_lighting_voxel_size_multiplier
Description:
Arguments:
[0.0f; 8.0f] - available range
1.0f - by default
bake_lightmap_viewport_mask
Description:
  • Variable. Prints the current viewport mask for the lightmapper.
  • Command. Assigns a new viewport mask for the lightmapper. For a light or surface to contribute to static GI, their viewport masks should match the baking viewport mask.
Arguments:
Viewport mask
bake_lightmap_zfar
Description:
Arguments:
[0.0f; inf] - available range
1000.0f - by default
bake_lightmap_quality
Description:
  • Variable.   Prints the current global baking quality for lightmaps.
  • Command.   Sets the global baking quality for lightmaps.
Arguments:
0 - Draft
1 - Low
2 - Medium (by default)
3 - High
4 - Ultra
bake_lighting_start
Description:
  • Command. Starts bake lighting.
bake_lighting_stop
Description:
  • Command. Stops bake lighting.

Screenshots#

Operations on screenshots.

screenshot_extensionConfig file: *.user
Description:
  • Variable.   Prints the current screenshot format.
  • Command.   Sets the screenshot format.
Arguments:
Extension for screenshot files: "png", "jpg", "dds", "tga", etc... ("tga" is used by default)
screenshot
Description:
  • Command. Takes a screenshot.
Notice
A screenshot is saved in the bin/screenshots directory by default. You can specify another directory.
Arguments:
Path to the folder the screenshots will be saved in (optional)

Memory Allocator#

memory_clear
Description:
  • Command. Clears the video memory, ffp buffer and memory pools, deletes textures and all meshes, including skinned meshes and decals. Memory is cleared automatically after the world is loaded or the render preset has been changed. It is recommended to use this command only in case a significant amount of memory needs to be released, the resources will be force removed at the end of the frame.

RAM Allocations#

Operations on memory allocations.

memory_info
Description:
  • Command. Prints information on small allocations in the static and dynamic memory pools.
memory_statistics_enabled
Description:
  • Command. Prints the value indicating whether gathering memory statistics is enabled or not.
memory_optimize_static_pools
Description:
  • Command. Updates and optimizes the static memory pools. The command can receive three arguments.
Arguments:
  • by_default - a flag indicating if the pool will be optimized for all the platforms or it will be customized for the current binary executable. To optimize pools for the current platform according to the current configuration, pass false. This way you can create several configurations of the static pools for different platforms. The default value is true.
  • overflow - a permissible difference between the maximum potential memory consumption and the current memory consumption. This value can be useful for reducing allocations during memory spikes. When set to 0, it generates the static pools based on current memory consumption. The default value is 64 Mb.
  • max_size - the maximum size of all static pools. The default value is 8192 Mb.
memory_dynamic_pool
Description:
  • Variable. Sets the maximum size of the dynamic pool in bytes.
  • Command. Prints the maximum size of the dynamic pool in bytes.
Arguments:
Pool size in bytes. 256 by default.

VRAM Allocations#

Operations on video memory allocations.

video_memory_info
Description:
  • Command. Prints information on small video memory allocations.
d3d12_small_pool_enabled
Description:
  • Variable. Toggles small pool allocations on and off. You should call the boot_config_save command and restart the application to save and apply changes.
  • Command. Prints the value indicating whether small pool allocations are enabled or not.
Arguments:
  • 0 to disable allocations
  • 1 to enable allocations
d3d12_small_pool_size
Description:
  • Variable. Sets the current maximum size of the pool, in Kb.
  • Command. Prints the current maximum size of the pool, in Kb.
Arguments:
Pool size in Kb. 1024 by default.
d3d12_small_pool_chunk_size
Description:
  • Variable. Sets the minimum size of a video memory chunk that can be allocated, in Kb. The size of the chunk will be equal or greater than this value.
  • Command. Prints the current minimum size of a memory chunk that can be allocated, in Kb.
Arguments:
Video memory chunk size in Kb. 1024 by default.

Skinned Meshes and Decals Allocations#

skinned_mesh_pool_chunk_size
Description:
  • Variable. Sets the size of the VRAM chunk to be allocated within a separate pool for a skinned mesh.
  • Command. Prints the current size of the VRAM chunk allocated within a separate pool for a skinned mesh.
decal_pool_chunk_size
Description:
  • Variable. Sets the size of the VRAM chunk to be allocated within a separate pool for a decal.
  • Command. Prints the current size of the VRAM chunk allocated within a separate pool for a decal.

General Information#

CPU Info#

Operations, representing information on the CPU.

cpu_info
Description:
  • Command. Prints information on the CPU and instruction set supported by it.
cpu_frequency
Description:
  • Command. Prints the CPU frequency in MHz.
cpu_cores
Description:
  • Command. Prints the number of available CPU cores.
cpu_threads
Description:
  • Variable.   Prints the current CPU threads available.
  • Command.   Sets the CPU threads available.
Arguments:
[0; 1024] - available range
0 - by default
cpu_hyper_threading
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables CPU hyper threading.
Arguments:
0 - disabled (by default)
1 - enabled

System Info#

Operations representing information on the system.

binary_info
Description:
  • Command. Prints information on the engine binary.
system_info
Description:
  • Command. Prints information on the operating system and the engine build version.
system_memory
Description:
  • Command. Prints the system memory size in Mbytes.

Miscellaneous#

Miscellaneous commands.

gpu_thread_priority
Description:
  • Variable.   Prints the current GPU thread priority for the engine.
  • Command.   Sets the GPU thread priority for the engine. Available for DirectX only. Positive values increase the likelihood that the GPU scheduler will grant GPU execution cycles to the device when rendering. You should have a comprehensive understanding of GPU scheduling and profile your application to ensure that it behaves as intended. If used inappropriately, this parameter can impede rendering speed and result in a poor user experience.
Arguments:
[-7; 7] - available range
7 - by default
process_priorityConfig file: *.boot
Description:
  • Variable.   Prints the current engine process priority.
  • Command.   Sets the engine process priority. Available for Windows only. A process with a higher priority gets to use the free CPU time available while a lower priority process only has access to the CPU when the higher priority application doesn't need it. If used inappropriately, may significantly affect performance.
Arguments:
0 - idle
1 - normal (by default)
2 - high
3 - real-time
log_stdoutConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables log messages printing in stdout.
    Notice
    Logging to stdout may significantly affect performance, so switch this option off, when you don't need it. You can use log_file for debugging purposes, as it is more performance-friendly.
Arguments:
0 - disabled
1 - enabled (by default)
log_fileConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables log messages saving in the Engine's log file.
    Notice
    This option is used for debugging. Do not turn it off if you need to debug something.
Arguments:
0 - disabled
1 - enabled (by default)
dpi_awarenessConfig file: *.boot
Description:
  • Variable.   Prints the current DPI awareness mode, the value indicating how the application processes the DPI scaling.
  • Command.   Sets the DPI awareness mode, the value indicating how the application processes the DPI scaling.
Arguments:
-1 — user configures DPI awareness.
0 - all displays are default DPI, bitmap-stretching.
1 - all displays have the same DPI from primary display, bitmap-stretching. (by default)
2 - DPI of the display that the window is primarily located on, no DPI scaling of any UI elements. Not available on Linux.
auto_dpi_scaling
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables applying automatic scaling to the window content.
Arguments:
0 - disabled
1 - enabled (by default)
swap_delay_warningConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the warning to the console that the swap has not been called within the period specified by swap_delay_warning_time.
Arguments:
0 - disabled (by default)
1 - enabled
swap_delay_warning_timeConfig file: *.boot
Description:
  • Variable.   Prints the current time in milliseconds, during which the swap should be called, otherwise swap_delay_warning is displayed in the console.
  • Command.   Sets the time in milliseconds, during which the swap should be called, otherwise swap_delay_warning is displayed in the console.
Arguments:
[1.0; 1000000.0] - available range
200.0 - by default
Last update: 2024-11-11
Build: ()